From a23b6f5a4c6993a766878982d0d133ea2ec680df Mon Sep 17 00:00:00 2001 From: Twilio Date: Tue, 4 Jul 2023 16:53:22 +0000 Subject: [PATCH] [Librarian] Regenerated @ 6ed189cbba23e3c77c423ac17bd7bfccfc88b126 --- CHANGES.md | 27 + spec/json/twilio_accounts_v1.json | 353 +- spec/json/twilio_api_v2010.json | 15537 +++++++++++++++++----- spec/json/twilio_autopilot_v1.json | 1837 ++- spec/json/twilio_bulkexports_v1.json | 331 +- spec/json/twilio_chat_v1.json | 1825 ++- spec/json/twilio_chat_v2.json | 2289 +++- spec/json/twilio_chat_v3.json | 51 +- spec/json/twilio_content_v1.json | 517 +- spec/json/twilio_conversations_v1.json | 5085 ++++++- spec/json/twilio_events_v1.json | 1055 +- spec/json/twilio_flex_v1.json | 3042 ++++- spec/json/twilio_flex_v2.json | 65 +- spec/json/twilio_frontline_v1.json | 64 +- spec/json/twilio_insights_v1.json | 3094 ++++- spec/json/twilio_intelligence_v2.json | 739 +- spec/json/twilio_ip_messaging_v1.json | 1757 ++- spec/json/twilio_ip_messaging_v2.json | 2337 +++- spec/json/twilio_lookups_bulk.json | 447 + spec/json/twilio_lookups_v1.json | 336 +- spec/json/twilio_lookups_v2.json | 619 +- spec/json/twilio_media_v1.json | 746 +- spec/json/twilio_messaging_bulk_v1.json | 271 + spec/json/twilio_messaging_v1.json | 2300 +++- spec/json/twilio_microvisor_v1.json | 927 +- spec/json/twilio_monitor_v1.json | 312 +- spec/json/twilio_notify_v1.json | 699 +- spec/json/twilio_numbers_v1.json | 562 +- spec/json/twilio_numbers_v2.json | 4167 +++++- spec/json/twilio_oauth_v1.json | 192 +- spec/json/twilio_preview.json | 12070 +++++++++++------ spec/json/twilio_pricing_v1.json | 372 +- spec/json/twilio_pricing_v2.json | 422 +- spec/json/twilio_proxy_v1.json | 1050 +- spec/json/twilio_routes_v2.json | 158 +- spec/json/twilio_serverless_v1.json | 1214 +- spec/json/twilio_studio_v1.json | 608 +- spec/json/twilio_studio_v2.json | 638 +- spec/json/twilio_supersim_v1.json | 2575 +++- spec/json/twilio_sync_v1.json | 1689 ++- spec/json/twilio_taskrouter_v1.json | 3601 ++++- spec/json/twilio_trunking_v1.json | 897 +- spec/json/twilio_trusthub_v1.json | 3311 ++++- spec/json/twilio_verify_v2.json | 2764 +++- spec/json/twilio_video_v1.json | 2106 ++- spec/json/twilio_voice_v1.json | 1076 +- spec/json/twilio_wireless_v1.json | 1101 +- spec/yaml/twilio_accounts_v1.yaml | 227 +- spec/yaml/twilio_api_v2010.yaml | 11673 ++++++++++++---- spec/yaml/twilio_autopilot_v1.yaml | 1270 +- spec/yaml/twilio_bulkexports_v1.yaml | 218 +- spec/yaml/twilio_chat_v1.yaml | 1309 +- spec/yaml/twilio_chat_v2.yaml | 1626 ++- spec/yaml/twilio_chat_v3.yaml | 37 +- spec/yaml/twilio_content_v1.yaml | 365 +- spec/yaml/twilio_conversations_v1.yaml | 3682 ++++- spec/yaml/twilio_events_v1.yaml | 717 +- spec/yaml/twilio_flex_v1.yaml | 2128 ++- spec/yaml/twilio_flex_v2.yaml | 45 +- spec/yaml/twilio_frontline_v1.yaml | 45 +- spec/yaml/twilio_insights_v1.yaml | 2437 +++- spec/yaml/twilio_intelligence_v2.yaml | 529 +- spec/yaml/twilio_ip_messaging_v1.yaml | 1263 +- spec/yaml/twilio_ip_messaging_v2.yaml | 1674 ++- spec/yaml/twilio_lookups_bulk.yaml | 302 + spec/yaml/twilio_lookups_v1.yaml | 253 +- spec/yaml/twilio_lookups_v2.yaml | 509 +- spec/yaml/twilio_media_v1.yaml | 526 +- spec/yaml/twilio_messaging_bulk_v1.yaml | 265 + spec/yaml/twilio_messaging_v1.yaml | 1895 ++- spec/yaml/twilio_microvisor_v1.yaml | 611 +- spec/yaml/twilio_monitor_v1.yaml | 214 +- spec/yaml/twilio_notify_v1.yaml | 515 +- spec/yaml/twilio_numbers_v1.yaml | 433 +- spec/yaml/twilio_numbers_v2.yaml | 2685 +++- spec/yaml/twilio_oauth_v1.yaml | 135 +- spec/yaml/twilio_preview.yaml | 9898 +++++++++----- spec/yaml/twilio_pricing_v1.yaml | 232 +- spec/yaml/twilio_pricing_v2.yaml | 277 +- spec/yaml/twilio_proxy_v1.yaml | 731 +- spec/yaml/twilio_routes_v2.yaml | 112 +- spec/yaml/twilio_serverless_v1.yaml | 787 +- spec/yaml/twilio_studio_v1.yaml | 382 +- spec/yaml/twilio_studio_v2.yaml | 418 +- spec/yaml/twilio_supersim_v1.yaml | 1836 ++- spec/yaml/twilio_sync_v1.yaml | 1154 +- spec/yaml/twilio_taskrouter_v1.yaml | 2569 +++- spec/yaml/twilio_trunking_v1.yaml | 626 +- spec/yaml/twilio_trusthub_v1.yaml | 2509 +++- spec/yaml/twilio_verify_v2.yaml | 2000 ++- spec/yaml/twilio_video_v1.yaml | 1540 ++- spec/yaml/twilio_voice_v1.yaml | 723 +- spec/yaml/twilio_wireless_v1.yaml | 819 +- 93 files changed, 123326 insertions(+), 28110 deletions(-) create mode 100644 spec/json/twilio_lookups_bulk.json create mode 100644 spec/json/twilio_messaging_bulk_v1.json create mode 100644 spec/yaml/twilio_lookups_bulk.yaml create mode 100644 spec/yaml/twilio_messaging_bulk_v1.yaml diff --git a/CHANGES.md b/CHANGES.md index 449d51aa..e55120af 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,32 @@ twilio-oai changelog ==================== +[2023-07-04] Version 2.0.0-rc.1 +------------------------------- +**Api** +- Added `content_sid` as conditional parameter +- Removed `content_sid` as optional field **(breaking change)** + +**Insights** +- Added `annotation` to list summary output + +**Lookups** +- Add `reassigned_number` package to the lookup response + +**Numbers** +- Remove Sms capability property from HNO creation under version `/v2` of HNO API. **(breaking change)** +- Update required properties in LOA creation under version `/v2` of Authorization document API. **(breaking change)** +- Add hosted_number_order under version `/v2`. +- Update properties in Porting and Bulk Porting APIs. **(breaking change)** +- Added bulk Portability API under version `/v1`. +- Added Portability API under version `/v1`. + +**Taskrouter** +- Add api to fetch task queue statistics for multiple TaskQueues + +**Twiml** +- Add Google Voices and languages + + [2023-07-04] Version 2.0.0-rc.0 --------------------------- - rc changes diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 5133b14f..7a9f7e21 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "accounts.v1.auth_token_promotion": { "type": "object", @@ -165,12 +171,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -186,7 +186,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -203,8 +203,8 @@ "auth_token", "date_created" ], - "pathType": "instance", - "mountName": "auth_token_promotion" + "mountName": "auth_token_promotion", + "pathType": "instance" }, "post": { "description": "Promote the secondary Auth Token to primary. After promoting the new token, all requests to Twilio using your old primary Auth Token will result in an error.", @@ -214,6 +214,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.auth_token_promotion" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auth_token": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "url": "https://accounts.twilio.com/v1/AuthTokens/Promote" + } + } } } }, @@ -225,10 +236,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateAuthTokenPromotion", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateAuthTokenPromotion" } }, "/v1/Credentials": { @@ -237,7 +245,7 @@ "url": "https://accounts.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -256,8 +264,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Credentials" + "parent": "/Credentials", + "pathType": "list" }, "get": { "description": "Retrieves a collection of AWS Credentials belonging to the account used to make the request", @@ -305,16 +313,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -323,17 +333,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "credentials": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0" } } } @@ -348,10 +395,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialAws" }, "post": { "description": "Create a new AWS Credential", @@ -361,6 +405,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -373,9 +429,6 @@ } ], "operationId": "CreateCredentialAws", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -402,6 +455,15 @@ "required": [ "Credentials" ] + }, + "examples": { + "create": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Credentials": "aws_credentials" + } + } } } } @@ -421,8 +483,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Credentials" + "parent": "/Credentials", + "pathType": "instance" }, "get": { "description": "Fetch the AWS credentials specified by the provided Credential Sid", @@ -446,6 +508,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -457,10 +531,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialAws" }, "post": { "description": "Modify the properties of a given Account", @@ -484,6 +555,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -496,9 +579,6 @@ } ], "operationId": "UpdateCredentialAws", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -511,6 +591,14 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Credentials": "aws_credentials" + } + } } } } @@ -542,10 +630,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialAws" } }, "/v1/Credentials/PublicKeys": { @@ -561,9 +646,9 @@ "friendly_name", "date_created" ], - "pathType": "list", "parent": "/Credentials", - "mountName": "public_key" + "mountName": "public_key", + "pathType": "list" }, "get": { "description": "Retrieves a collection of Public Key Credentials belonging to the account used to make the request", @@ -611,16 +696,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -629,17 +716,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "credentials": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0", + "key": "credentials", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0" } } } @@ -654,10 +778,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialPublicKey" }, "post": { "description": "Create a new Public Key Credential", @@ -667,6 +788,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -679,9 +812,6 @@ } ], "operationId": "CreateCredentialPublicKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -708,6 +838,15 @@ "required": [ "PublicKey" ] + }, + "examples": { + "create": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PublicKey": "public_key" + } + } } } } @@ -727,9 +866,9 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Credentials", - "mountName": "public_key" + "mountName": "public_key", + "pathType": "instance" }, "get": { "description": "Fetch the public key specified by the provided Credential Sid", @@ -753,6 +892,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -764,10 +915,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialPublicKey" }, "post": { "description": "Modify the properties of a given Account", @@ -791,6 +939,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "friendly_name": "friendly_name", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -803,9 +963,6 @@ } ], "operationId": "UpdateCredentialPublicKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -818,6 +975,14 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "PublicKey": "public_key" + } + } } } } @@ -849,10 +1014,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialPublicKey" } }, "/v1/AuthTokens/Secondary": { @@ -868,8 +1030,8 @@ "secondary_auth_token", "date_created" ], - "pathType": "instance", - "mountName": "secondary_auth_token" + "mountName": "secondary_auth_token", + "pathType": "instance" }, "post": { "description": "Create a new secondary Auth Token", @@ -879,6 +1041,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.secondary_auth_token" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-31T04:00:00Z", + "date_updated": "2015-07-31T04:00:00Z", + "secondary_auth_token": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "url": "https://accounts.twilio.com/v1/AuthTokens/Secondary" + } + } } } }, @@ -890,10 +1063,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSecondaryAuthToken", - "x-maturity": [ - "GA" - ] + "operationId": "CreateSecondaryAuthToken" }, "delete": { "description": "Delete the secondary Auth Token from your account", @@ -907,10 +1077,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSecondaryAuthToken", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSecondaryAuthToken" } } }, @@ -918,11 +1085,5 @@ { "url": "https://accounts.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 33744360..ef68f66f 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "api.v2010.account": { "type": "object", @@ -4053,6 +4059,65 @@ "unconfirmed" ] }, + "message_real_resource_enum_status": { + "type": "string", + "enum": [ + "queued", + "sending", + "sent", + "failed", + "delivered", + "undelivered", + "receiving", + "received", + "accepted", + "scheduled", + "read", + "partially_delivered", + "canceled" + ] + }, + "message_real_resource_enum_update_status": { + "type": "string", + "enum": [ + "canceled" + ] + }, + "message_real_resource_enum_direction": { + "type": "string", + "enum": [ + "inbound", + "outbound-api", + "outbound-call", + "outbound-reply" + ] + }, + "message_real_resource_enum_content_retention": { + "type": "string", + "enum": [ + "retain", + "discard" + ] + }, + "message_real_resource_enum_address_retention": { + "type": "string", + "enum": [ + "retain", + "obfuscate" + ] + }, + "message_real_resource_enum_traffic_type": { + "type": "string", + "enum": [ + "free" + ] + }, + "message_real_resource_enum_schedule_type": { + "type": "string", + "enum": [ + "fixed" + ] + }, "api.v2010.account.new_key": { "type": "object", "properties": { @@ -5818,6 +5883,25 @@ "stopped" ] }, + "sms_message_enum_status": { + "type": "string", + "enum": [ + "queued", + "sending", + "sent", + "failed", + "received" + ] + }, + "sms_message_enum_direction": { + "type": "string", + "enum": [ + "inbound", + "outbound-api", + "outbound-call", + "outbound-reply" + ] + }, "api.v2010.account.call.stream": { "type": "object", "properties": { @@ -9576,12 +9660,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -9597,7 +9675,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -9614,7 +9692,6 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { "address": "{account_sid: sid}", "application": "{account_sid: sid}", @@ -9627,7 +9704,6 @@ "incoming_phone_number": "{account_sid: sid}", "key": "{account_sid: sid}", "message": "{account_sid: sid}", - "api/v2010/message_real_resource": "{account_sid: sid}", "new_key": "{account_sid: sid}", "new_signing_key": "{account_sid: sid}", "notification": "{account_sid: sid}", @@ -9636,13 +9712,14 @@ "recording": "{account_sid: sid}", "signing_key": "{account_sid: sid}", "sip": "{account_sid: sid}", - "api/v2010/sms": "{account_sid: sid}", + "sms": "{account_sid: sid}", "short_code": "{account_sid: sid}", "token": "{account_sid: sid}", "transcription": "{account_sid: sid}", "usage": "{account_sid: sid}", "validation_request": "{account_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new Twilio Subaccount from the account making the request", @@ -9652,6 +9729,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account" + }, + "examples": { + "create": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9664,9 +9778,6 @@ } ], "operationId": "CreateAccount", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9679,6 +9790,13 @@ "description": "A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}`" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -9693,6 +9811,14 @@ "description": "Only return the Account resources with friendly names that exactly match this name.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "friendly_name" + }, + "readFull": { + "value": "friendly_name" + } } }, { @@ -9702,6 +9828,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/account_enum_status" + }, + "examples": { + "readEmpty": { + "value": "active" + }, + "readFull": { + "value": "active" + } } }, { @@ -9737,44 +9871,115 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAccountResponse", - "properties": { - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAccountResponse", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "accounts": [], + "uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "accounts": [ + { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "uri": "/2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -9788,10 +9993,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccount", - "x-maturity": [ - "GA" - ] + "operationId": "ListAccount" } }, "/2010-04-01/Accounts/{Sid}.json": { @@ -9807,7 +10009,6 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { "address": "{account_sid: sid}", "application": "{account_sid: sid}", @@ -9820,7 +10021,6 @@ "incoming_phone_number": "{account_sid: sid}", "key": "{account_sid: sid}", "message": "{account_sid: sid}", - "api/v2010/message_real_resource": "{account_sid: sid}", "new_key": "{account_sid: sid}", "new_signing_key": "{account_sid: sid}", "notification": "{account_sid: sid}", @@ -9829,13 +10029,14 @@ "recording": "{account_sid: sid}", "signing_key": "{account_sid: sid}", "sip": "{account_sid: sid}", - "api/v2010/sms": "{account_sid: sid}", + "sms": "{account_sid: sid}", "short_code": "{account_sid: sid}", "token": "{account_sid: sid}", "transcription": "{account_sid: sid}", "usage": "{account_sid: sid}", "validation_request": "{account_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch the account specified by the provided Account Sid", @@ -9859,6 +10060,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account" + }, + "examples": { + "fetch": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9870,10 +10108,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccount", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccount" }, "post": { "description": "Modify the properties of a given Account", @@ -9897,6 +10132,78 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account" + }, + "examples": { + "update": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "updateWithNumericStatus": { + "value": { + "auth_token": "auth_token", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "owner_account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "subresource_uris": { + "available_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json", + "calls": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json", + "conferences": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json", + "incoming_phone_numbers": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "outgoing_caller_ids": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json", + "addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json", + "signing_keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json", + "connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json", + "sip": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json", + "authorized_connect_apps": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json", + "usage": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json", + "keys": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json", + "applications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json", + "short_codes": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json", + "queues": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json", + "messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json", + "balance": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json" + }, + "type": "Full", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9909,9 +10216,6 @@ } ], "operationId": "UpdateAccount", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9929,6 +10233,19 @@ "description": "Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Status": "active" + } + }, + "updateWithNumericStatus": { + "value": { + "Status": "1" + } + } } } } @@ -9949,11 +10266,11 @@ "validated", "verified" ], - "pathType": "list", "dependentProperties": { "dependent_phone_number": "{account_sid: account_sid, address_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "", @@ -9977,6 +10294,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.address" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -9989,9 +10328,6 @@ } ], "operationId": "CreateAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10049,6 +10385,19 @@ "PostalCode", "IsoCountry" ] + }, + "examples": { + "create": { + "value": { + "City": "city", + "CustomerName": "customer_name", + "FriendlyName": "friendly_name", + "IsoCountry": "US", + "PostalCode": "postal_code", + "Region": "region", + "Street": "street" + } + } } } } @@ -10075,6 +10424,14 @@ "description": "The `customer_name` of the Address resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "customer_name" + }, + "readEmpty": { + "value": "customer_name" + } } }, { @@ -10083,6 +10440,14 @@ "description": "The string that identifies the Address resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -10092,6 +10457,14 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readFull": { + "value": "US" + }, + "readEmpty": { + "value": "US" + } } }, { @@ -10127,44 +10500,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAddressResponse", - "properties": { - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.address" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAddressResponse", + "properties": { + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.address" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "addresses": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "addresses": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0" } } } @@ -10178,10 +10613,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListAddress" } }, "/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json": { @@ -10198,11 +10630,11 @@ "validated", "verified" ], - "pathType": "instance", "dependentProperties": { "dependent_phone_number": "{account_sid: account_sid, address_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "", @@ -10242,10 +10674,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteAddress" }, "get": { "description": "", @@ -10281,6 +10710,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.address" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -10292,10 +10743,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAddress" }, "post": { "description": "", @@ -10331,6 +10779,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.address" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "city": "SF", + "customer_name": "name", + "date_created": "Tue, 18 Aug 2015 17:07:30 +0000", + "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000", + "emergency_enabled": false, + "friendly_name": null, + "iso_country": "US", + "postal_code": "94019", + "region": "CA", + "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "street": "4th", + "street_secondary": null, + "validated": false, + "verified": false, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -10343,9 +10813,6 @@ } ], "operationId": "UpdateAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10390,6 +10857,18 @@ "description": "The additional number and street address of the address." } } + }, + "examples": { + "update": { + "value": { + "City": "city", + "CustomerName": "customer_name", + "FriendlyName": "friendly_name", + "PostalCode": "postal_code", + "Region": "region", + "Street": "street" + } + } } } } @@ -10409,8 +10888,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new application within your account", @@ -10434,6 +10913,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:59:45 +0000", + "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000", + "friendly_name": "Application Friendly Name", + "message_status_callback": "http://www.example.com/sms-status-callback", + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "http://www.example.com/sms-fallback", + "sms_method": "GET", + "sms_status_callback": "http://www.example.com/sms-status-callback", + "sms_url": "http://example.com", + "status_callback": "http://example.com", + "status_callback_method": "GET", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "http://www.example.com/voice-callback", + "voice_method": "GET", + "voice_url": "http://example.com", + "public_application_connect_enabled": true + } + } } } }, @@ -10446,9 +10952,6 @@ } ], "operationId": "CreateApplication", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10573,6 +11076,27 @@ "description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "MessageStatusCallback": "https://example.com", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsStatusCallback": "https://example.com", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceCallerIdLookup": true, + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "PublicApplicationConnectEnabled": true + } + } } } } @@ -10599,6 +11123,14 @@ "description": "The string that identifies the Application resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -10634,44 +11166,105 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListApplicationResponse", - "properties": { - "applications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.application" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListApplicationResponse", + "properties": { + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.application" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "applications": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 21 Aug 2015 00:07:25 +0000", + "date_updated": "Fri, 21 Aug 2015 00:07:25 +0000", + "friendly_name": "d8821fb7-4d01-48b2-bdc5-34e46252b90b", + "message_status_callback": null, + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_status_callback": null, + "sms_url": null, + "status_callback": null, + "status_callback_method": "POST", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "public_application_connect_enabled": false + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "page_size": 1, + "page": 0, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "applications": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0", + "previous_page_uri": null, + "page_size": 1, + "start": 0, + "next_page_uri": null, + "page": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0" } } } @@ -10685,10 +11278,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListApplication", - "x-maturity": [ - "GA" - ] + "operationId": "ListApplication" } }, "/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json": { @@ -10704,8 +11294,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Delete the application by the specified application sid", @@ -10745,10 +11335,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteApplication", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteApplication" }, "get": { "description": "Fetch the application specified by the provided sid", @@ -10784,6 +11371,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:59:45 +0000", + "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000", + "friendly_name": "Application Friendly Name", + "message_status_callback": "http://www.example.com/sms-status-callback", + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "http://www.example.com/sms-fallback", + "sms_method": "GET", + "sms_status_callback": "http://www.example.com/sms-status-callback", + "sms_url": "http://example.com", + "status_callback": "http://example.com", + "status_callback_method": "GET", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "http://www.example.com/voice-callback", + "voice_method": "GET", + "voice_url": "http://example.com", + "public_application_connect_enabled": false + } + } } } }, @@ -10795,10 +11409,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApplication", - "x-maturity": [ - "GA" - ] + "operationId": "FetchApplication" }, "post": { "description": "Updates the application's properties", @@ -10834,6 +11445,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:59:45 +0000", + "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000", + "friendly_name": "Application Friendly Name", + "message_status_callback": "http://www.example.com/sms-status-callback", + "sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "http://www.example.com/sms-fallback", + "sms_method": "GET", + "sms_status_callback": "http://www.example.com/sms-status-callback", + "sms_url": "http://example.com", + "status_callback": "http://example.com", + "status_callback_method": "GET", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "http://www.example.com/voice-callback", + "voice_method": "GET", + "voice_url": "http://example.com", + "public_application_connect_enabled": true + } + } } } }, @@ -10846,9 +11484,6 @@ } ], "operationId": "UpdateApplication", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10973,6 +11608,27 @@ "description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "MessageStatusCallback": "https://example.com", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsStatusCallback": "https://example.com", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceCallerIdLookup": true, + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "PublicApplicationConnectEnabled": true + } + } } } } @@ -10991,8 +11647,8 @@ "connect_app_sid", "connect_app_friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an authorized-connect-app", @@ -11028,6 +11684,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connect_app_company_name": "aaa", + "connect_app_description": "alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj", + "connect_app_friendly_name": "aaa", + "connect_app_homepage_url": "http://www.google.com", + "connect_app_sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "permissions": [ + "get-all" + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -11039,10 +11713,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAuthorizedConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAuthorizedConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json": { @@ -11057,8 +11728,8 @@ "connect_app_sid", "connect_app_friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of authorized-connect-apps belonging to the account used to make the request", @@ -11108,44 +11779,102 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAuthorizedConnectAppResponse", - "properties": { - "authorized_connect_apps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAuthorizedConnectAppResponse", + "properties": { + "authorized_connect_apps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "authorized_connect_apps": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connect_app_company_name": "YOUR OTHER MOM", + "connect_app_description": "alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj", + "connect_app_friendly_name": "YOUR MOM", + "connect_app_homepage_url": "http://www.google.com", + "connect_app_sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "permissions": [ + "get-all" + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json" + } + }, + "readEmpty": { + "value": { + "authorized_connect_apps": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json" } } } @@ -11159,10 +11888,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAuthorizedConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "ListAuthorizedConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json": { @@ -11178,7 +11904,6 @@ "country", "beta" ], - "pathType": "list", "dependentProperties": { "local": "{account_sid: account_sid, country_code: country_code}", "toll_free": "{account_sid: account_sid, country_code: country_code}", @@ -11189,7 +11914,8 @@ "machine_to_machine": "{account_sid: account_sid, country_code: country_code}" }, "parent": "/Accounts/{Sid}.json", - "className": "available_phone_number_country" + "className": "available_phone_number_country", + "pathType": "list" }, "get": { "description": "", @@ -11239,47 +11965,81 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberCountryResponse", - "properties": { - "countries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberCountryResponse", + "properties": { + "countries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" } - } - } + ] + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "beta": false, + "country": "Denmark", + "country_code": "DK", + "subresource_uris": { + "local": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK/Local.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK.json" + } + ], + "end": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json" + } + }, + "readEmpty": { + "value": { + "countries": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json" + } + } + } } }, "description": "OK" @@ -11290,10 +12050,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberCountry" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json": { @@ -11309,7 +12066,6 @@ "country", "beta" ], - "pathType": "instance", "dependentProperties": { "local": "{account_sid: account_sid, country_code: country_code}", "toll_free": "{account_sid: account_sid, country_code: country_code}", @@ -11320,7 +12076,8 @@ "machine_to_machine": "{account_sid: account_sid, country_code: country_code}" }, "parent": "/Accounts/{Sid}.json", - "className": "available_phone_number_country" + "className": "available_phone_number_country", + "pathType": "instance" }, "get": { "description": "", @@ -11354,6 +12111,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" + }, + "examples": { + "fetch": { + "value": { + "beta": null, + "country": "United States", + "country_code": "US", + "subresource_uris": { + "local": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json", + "toll_free": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US.json" + } + } } } }, @@ -11365,10 +12136,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAvailablePhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAvailablePhoneNumberCountry" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json": { @@ -11384,8 +12152,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -11482,6 +12250,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -11590,44 +12366,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberLocalResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberLocalResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "friendly_name": "(808) 925-1571", + "iso_country": "US", + "lata": "834", + "latitude": "19.720000", + "locality": "Hilo", + "longitude": "-155.090000", + "phone_number": "+18089251571", + "postal_code": "96720", + "rate_center": "HILO", + "region": "HI" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json" } } } @@ -11641,10 +12460,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberLocal", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberLocal" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json": { @@ -11660,8 +12476,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -11758,6 +12574,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -11866,44 +12690,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberMachineToMachineResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberMachineToMachineResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json" } } } @@ -11917,10 +12784,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberMachineToMachine", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberMachineToMachine" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json": { @@ -11936,8 +12800,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12034,6 +12898,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12142,44 +13014,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberMobileResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberMobileResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json" } } } @@ -12193,10 +13108,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberMobile", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberMobile" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json": { @@ -12212,8 +13124,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12310,6 +13222,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12418,44 +13338,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberNationalResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberNationalResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json" } } } @@ -12469,10 +13432,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberNational", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberNational" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json": { @@ -12488,8 +13448,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12586,6 +13546,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12694,44 +13662,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberSharedCostResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberSharedCostResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json" } } } @@ -12745,10 +13756,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberSharedCost", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberSharedCost" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json": { @@ -12764,8 +13772,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12862,6 +13870,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -12970,44 +13986,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberTollFreeResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberTollFreeResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": true, + "sms": true, + "voice": true + }, + "friendly_name": "(800) 100-0052", + "iso_country": "US", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+18001000052", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" } } } @@ -13021,10 +14080,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberTollFree", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberTollFree" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json": { @@ -13040,8 +14096,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -13138,6 +14194,14 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -13246,44 +14310,87 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListAvailablePhoneNumberVoipResponse", - "properties": { - "available_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListAvailablePhoneNumberVoipResponse", + "properties": { + "available_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "available_phone_numbers": [ + { + "address_requirements": "none", + "beta": false, + "capabilities": { + "mms": false, + "sms": true, + "voice": false + }, + "friendly_name": "+4759440374", + "iso_country": "NO", + "lata": null, + "latitude": null, + "locality": null, + "longitude": null, + "phone_number": "+4759440374", + "postal_code": null, + "rate_center": null, + "region": null + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json" + } + }, + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json" } } } @@ -13297,10 +14404,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberVoip", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberVoip" } }, "/2010-04-01/Accounts/{AccountSid}/Balance.json": { @@ -13316,8 +14420,8 @@ "balance", "currency" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Fetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance information", @@ -13341,6 +14445,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.balance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "balance": "0.05", + "currency": "USD" + } + } } } }, @@ -13352,10 +14465,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBalance", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBalance" } }, "/2010-04-01/Accounts/{AccountSid}/Calls.json": { @@ -13373,7 +14483,6 @@ "status", "start_time" ], - "pathType": "list", "dependentProperties": { "recording": "{account_sid: account_sid, call_sid: sid}", "notification": "{account_sid: account_sid, call_sid: sid}", @@ -13385,7 +14494,8 @@ "user_defined_message_subscription": "{account_sid: account_sid, call_sid: sid}", "user_defined_message": "{account_sid: account_sid, call_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections", @@ -13409,6 +14519,92 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": null, + "answered_by": null, + "api_version": "2010-04-01", + "caller_name": null, + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "direction": "inbound", + "duration": "15", + "end_time": "Tue, 31 Aug 2010 20:36:44 +0000", + "forwarded_from": "+141586753093", + "from": "+14158675308", + "from_formatted": "(415) 867-5308", + "group_sid": null, + "parent_call_sid": null, + "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "price": "-0.03000", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Tue, 31 Aug 2010 20:36:29 +0000", + "status": "completed", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+14158675309", + "to_formatted": "(415) 867-5309", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + }, + "createWithTwiml": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": null, + "answered_by": null, + "api_version": "2010-04-01", + "caller_name": null, + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "direction": "inbound", + "duration": "15", + "end_time": "Tue, 31 Aug 2010 20:36:44 +0000", + "forwarded_from": "+141586753093", + "from": "+14158675308", + "from_formatted": "(415) 867-5308", + "group_sid": null, + "parent_call_sid": null, + "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "price": "-0.03000", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Tue, 31 Aug 2010 20:36:29 +0000", + "status": "completed", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+14158675309", + "to_formatted": "(415) 867-5309", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + } } } }, @@ -13421,9 +14617,6 @@ } ], "operationId": "CreateCall", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -13640,6 +14833,78 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "From": "+987654321", + "IfMachine": "if_machine", + "MachineDetection": "enable", + "MachineDetectionTimeout": 15, + "Method": "GET", + "Record": "true", + "RecordingTrack": "both", + "Trim": "do-not-trim", + "SendDigits": "send_digits", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "Timeout": 1, + "To": "+123456789", + "Url": "https://example.com", + "CallerId": "Caller", + "MachineDetectionSpeechThreshold": 3000, + "MachineDetectionSpeechEndThreshold": 3000, + "MachineDetectionSilenceTimeout": 3000, + "AsyncAmd": "true", + "AsyncAmdStatusCallback": "http://statuscallback.com", + "AsyncAmdStatusCallbackMethod": "POST", + "MachineDetectionEngine": "Lumenvox", + "MachineDetectionMinWordLength": 100, + "MachineDetectionMaxWordLength": 5000, + "MachineDetectionWordsSilence": 50, + "MachineDetectionMaxNumOfWords": 5, + "MachineDetectionSilenceThreshold": 256, + "Byoc": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CallReason": "Reason for the call (Beta)", + "TimeLimit": 3600, + "CallToken": "call-token-string", + "Transcribe": "true", + "TranscriptionConfiguration": "JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithTwiml": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "From": "+987654321", + "IfMachine": "if_machine", + "MachineDetection": "enable", + "MachineDetectionTimeout": 15, + "Method": "", + "Record": "true", + "Trim": "do-not-trim", + "SendDigits": "send_digits", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "Timeout": 1, + "To": "+123456789", + "Url": "", + "CallerId": "Caller", + "MachineDetectionSpeechThreshold": 3000, + "MachineDetectionSpeechEndThreshold": 3000, + "MachineDetectionSilenceTimeout": 3000, + "Twiml": "Enjoy", + "CallReason": "Reason for the call (Beta)", + "TimeLimit": 3600, + "CallToken": "call-token-string", + "Transcribe": "true", + "TranscriptionConfiguration": "JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -13676,6 +14941,23 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFullPage1": { + "value": "+123456789" + }, + "readFullPage2": { + "value": "+123456789" + }, + "readEmptyDatesGreater": { + "value": "+123456789" + }, + "readEmptyDatesLess": { + "value": "+123456789" + }, + "readEmptyDateFunDateFormats": { + "value": "+123456789" + } } }, { @@ -13685,6 +14967,23 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFullPage1": { + "value": "+987654321" + }, + "readFullPage2": { + "value": "+987654321" + }, + "readEmptyDatesGreater": { + "value": "+987654321" + }, + "readEmptyDatesLess": { + "value": "+987654321" + }, + "readEmptyDateFunDateFormats": { + "value": "+987654321" + } } }, { @@ -13696,6 +14995,23 @@ "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFullPage1": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFullPage2": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmptyDatesGreater": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmptyDatesLess": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmptyDateFunDateFormats": { + "value": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -13705,6 +15021,23 @@ "schema": { "type": "string", "$ref": "#/components/schemas/call_enum_status" + }, + "examples": { + "readFullPage1": { + "value": "completed" + }, + "readFullPage2": { + "value": "completed" + }, + "readEmptyDatesGreater": { + "value": "completed" + }, + "readEmptyDatesLess": { + "value": "completed" + }, + "readEmptyDateFunDateFormats": { + "value": "completed" + } } }, { @@ -13714,6 +15047,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2008-01-02" + }, + "readFullPage2": { + "value": "2008-01-02" + } } }, { @@ -13723,6 +15064,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesLess": { + "value": "2008-01-02" + }, + "readEmptyDateFunDateFormats": { + "value": "06/11/2019 22:05:25 MST" + } } }, { @@ -13732,6 +15081,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesGreater": { + "value": "2008-01-02" + } } }, { @@ -13741,6 +15095,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2009-01-02" + }, + "readFullPage2": { + "value": "2009-01-02" + } } }, { @@ -13750,6 +15112,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesLess": { + "value": "2009-01-02" + }, + "readEmptyDateFunDateFormats": { + "value": "2019-06-11 22:05:25.000" + } } }, { @@ -13759,6 +15129,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesGreater": { + "value": "2009-01-02" + } } }, { @@ -13794,44 +15169,282 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCallResponse", - "properties": { - "calls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallResponse", + "properties": { + "calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFullPage1": { + "value": { + "calls": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": "billingreferencetag1", + "answered_by": "machine_start", + "api_version": "2010-04-01", + "caller_name": "callerid1", + "date_created": "Fri, 18 Oct 2019 17:00:00 +0000", + "date_updated": "Fri, 18 Oct 2019 17:01:00 +0000", + "direction": "outbound-api", + "duration": "4", + "end_time": "Fri, 18 Oct 2019 17:03:00 +0000", + "forwarded_from": "calledvia1", + "from": "+13051416799", + "from_formatted": "(305) 141-6799", + "group_sid": "GPdeadbeefdeadbeefdeadbeefdeadbeef", + "parent_call_sid": "CAdeadbeefdeadbeefdeadbeefdeadbeef", + "phone_number_sid": "PNdeadbeefdeadbeefdeadbeefdeadbeef", + "price": "-0.200", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Fri, 18 Oct 2019 17:02:00 +0000", + "status": "completed", + "subresource_uris": { + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+13051913581", + "to_formatted": "(305) 191-3581", + "trunk_sid": "TKdeadbeefdeadbeefdeadbeefdeadbeef", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": "billingreferencetag2", + "answered_by": "human", + "api_version": "2010-04-01", + "caller_name": "callerid2", + "date_created": "Fri, 18 Oct 2019 16:00:00 +0000", + "date_updated": "Fri, 18 Oct 2019 16:01:00 +0000", + "direction": "inbound", + "duration": "3", + "end_time": "Fri, 18 Oct 2019 16:03:00 +0000", + "forwarded_from": "calledvia2", + "from": "+13051416798", + "from_formatted": "(305) 141-6798", + "group_sid": "GPdeadbeefdeadbeefdeadbeefdeadbeee", + "parent_call_sid": "CAdeadbeefdeadbeefdeadbeefdeadbeee", + "phone_number_sid": "PNdeadbeefdeadbeefdeadbeefdeadbeee", + "price": "-0.100", + "price_unit": "JPY", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0", + "start_time": "Fri, 18 Oct 2019 16:02:00 +0000", + "status": "completed", + "subresource_uris": { + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Recordings.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessages.json" + }, + "to": "+13051913580", + "to_formatted": "(305) 191-3580", + "trunk_sid": "TKdeadbeefdeadbeefdeadbeefdeadbeef", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0.json", + "queue_time": "1000" + } + ], + "end": 1, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&From=%2B987654321&StartTime=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EndTime=2009-01-02&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&From=%2B987654321&StartTime=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EndTime=2009-01-02&PageSize=2&Page=1&PageToken=PACAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0", + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&From=%2B987654321&StartTime=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EndTime=2009-01-02&PageSize=2&Page=0" + } + }, + "readFullPage2": { + "value": { + "calls": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": "billingreferencetag1", + "answered_by": "machine_start", + "api_version": "2010-04-01", + "caller_name": "callerid1", + "date_created": "Fri, 18 Oct 2019 17:00:00 +0000", + "date_updated": "Fri, 18 Oct 2019 17:01:00 +0000", + "direction": "outbound-api", + "duration": "4", + "end_time": "Fri, 18 Oct 2019 17:03:00 +0000", + "forwarded_from": "calledvia1", + "from": "+13051416799", + "from_formatted": "(305) 141-6799", + "group_sid": "GPdeadbeefdeadbeefdeadbeefdeadbeef", + "parent_call_sid": "CAdeadbeefdeadbeefdeadbeefdeadbeef", + "phone_number_sid": "PNdeadbeefdeadbeefdeadbeefdeadbeef", + "price": "-0.200", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Fri, 18 Oct 2019 17:02:00 +0000", + "status": "completed", + "subresource_uris": { + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+13051913581", + "to_formatted": "(305) 191-3581", + "trunk_sid": "TKdeadbeefdeadbeefdeadbeefdeadbeef", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": "billingreferencetag2", + "answered_by": "human", + "api_version": "2010-04-01", + "caller_name": "callerid2", + "date_created": "Fri, 18 Oct 2019 16:00:00 +0000", + "date_updated": "Fri, 18 Oct 2019 16:01:00 +0000", + "direction": "inbound", + "duration": "3", + "end_time": "Fri, 18 Oct 2019 16:03:00 +0000", + "forwarded_from": "calledvia2", + "from": "+13051416798", + "from_formatted": "(305) 141-6798", + "group_sid": "GPdeadbeefdeadbeefdeadbeefdeadbeee", + "parent_call_sid": "CAdeadbeefdeadbeefdeadbeefdeadbeee", + "phone_number_sid": "PNdeadbeefdeadbeefdeadbeefdeadbeee", + "price": "-0.100", + "price_unit": "JPY", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0", + "start_time": "Fri, 18 Oct 2019 16:02:00 +0000", + "status": "completed", + "subresource_uris": { + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Recordings.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessages.json" + }, + "to": "+13051913580", + "to_formatted": "(305) 191-3580", + "trunk_sid": "TKdeadbeefdeadbeefdeadbeefdeadbeef", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0.json", + "queue_time": "1000" + } + ], + "end": 3, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=2&PageToken=PACAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0", + "page": 1, + "page_size": 2, + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=0&PageToken=PBCAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start": 2, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=1&PageToken=PACAdeadbeefdeadbeefdeadbeefdeadbeef" + } + }, + "readEmptyDatesGreater": { + "value": { + "calls": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&EndTime%3E=2009-01-02&From=%2B987654321&StartTime%3E=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&EndTime%3E=2009-01-02&From=%2B987654321&StartTime%3E=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=2&Page=0" + } + }, + "readEmptyDatesLess": { + "value": { + "calls": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2009-01-02&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=2008-01-02&PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2009-01-02&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=2008-01-02&PageSize=2&Page=0" + } + }, + "readEmptyDateFunDateFormats": { + "value": { + "calls": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0" } } } @@ -13845,10 +15458,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCall", - "x-maturity": [ - "GA" - ] + "operationId": "ListCall" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json": { @@ -13866,7 +15476,6 @@ "status", "start_time" ], - "pathType": "instance", "dependentProperties": { "recording": "{account_sid: account_sid, call_sid: sid}", "notification": "{account_sid: account_sid, call_sid: sid}", @@ -13878,7 +15487,8 @@ "user_defined_message_subscription": "{account_sid: account_sid, call_sid: sid}", "user_defined_message": "{account_sid: account_sid, call_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Delete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs.", @@ -13918,10 +15528,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCall", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCall" }, "get": { "description": "Fetch the call specified by the provided Call SID", @@ -13957,6 +15564,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": "billingreferencetag", + "answered_by": "machine_start", + "api_version": "2010-04-01", + "caller_name": "callerid", + "date_created": "Fri, 18 Oct 2019 17:00:00 +0000", + "date_updated": "Fri, 18 Oct 2019 17:01:00 +0000", + "direction": "outbound-api", + "duration": "4", + "end_time": "Fri, 18 Oct 2019 17:03:00 +0000", + "forwarded_from": "calledvia", + "from": "+13051416799", + "from_formatted": "(305) 141-6799", + "group_sid": "GPdeadbeefdeadbeefdeadbeefdeadbeef", + "parent_call_sid": "CAdeadbeefdeadbeefdeadbeefdeadbeef", + "phone_number_sid": "PNdeadbeefdeadbeefdeadbeefdeadbeef", + "price": "-0.200", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Fri, 18 Oct 2019 17:02:00 +0000", + "status": "completed", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+13051913581", + "to_formatted": "(305) 191-3581", + "trunk_sid": "TKdeadbeefdeadbeefdeadbeefdeadbeef", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + } } } }, @@ -13968,10 +15619,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCall", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCall" }, "post": { "description": "Initiates a call redirect or terminates a call", @@ -14007,9 +15655,179 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call" - } - } - }, + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": null, + "answered_by": null, + "api_version": "2010-04-01", + "caller_name": null, + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "direction": "inbound", + "duration": "15", + "end_time": "Tue, 31 Aug 2010 20:36:44 +0000", + "forwarded_from": "+141586753093", + "from": "+14158675308", + "from_formatted": "(415) 867-5308", + "group_sid": null, + "parent_call_sid": null, + "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "price": "-0.03000", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Tue, 31 Aug 2010 20:36:29 +0000", + "status": "completed", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+14158675309", + "to_formatted": "(415) 867-5309", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + }, + "cancel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": null, + "answered_by": null, + "api_version": "2010-04-01", + "caller_name": null, + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "direction": "inbound", + "duration": "15", + "end_time": "Tue, 31 Aug 2010 20:36:44 +0000", + "forwarded_from": "+141586753093", + "from": "+14158675308", + "from_formatted": "(415) 867-5308", + "group_sid": null, + "parent_call_sid": null, + "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "price": "-0.03000", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Tue, 31 Aug 2010 20:36:29 +0000", + "status": "canceled", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+14158675309", + "to_formatted": "(415) 867-5309", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + }, + "posttwiml": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": null, + "answered_by": null, + "api_version": "2010-04-01", + "caller_name": null, + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "direction": "inbound", + "duration": "15", + "end_time": "Tue, 31 Aug 2010 20:36:44 +0000", + "forwarded_from": "+141586753093", + "from": "+14158675308", + "from_formatted": "(415) 867-5308", + "group_sid": null, + "parent_call_sid": null, + "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "price": "-0.03000", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Tue, 31 Aug 2010 20:36:29 +0000", + "status": "canceled", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+14158675309", + "to_formatted": "(415) 867-5309", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + }, + "updatetimelimit": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "annotation": null, + "answered_by": null, + "api_version": "2010-04-01", + "caller_name": null, + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", + "direction": "inbound", + "duration": "15", + "end_time": "Tue, 31 Aug 2010 20:36:44 +0000", + "forwarded_from": "+141586753093", + "from": "+14158675308", + "from_formatted": "(415) 867-5308", + "group_sid": null, + "parent_call_sid": null, + "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "price": "-0.03000", + "price_unit": "USD", + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "start_time": "Tue, 31 Aug 2010 20:36:29 +0000", + "status": "canceled", + "subresource_uris": { + "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json", + "feedback_summaries": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json", + "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json", + "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json", + "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json", + "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json", + "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json", + "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json" + }, + "to": "+14158675309", + "to_formatted": "(415) 867-5309", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "queue_time": "1000" + } + } + } + } + }, "description": "OK" } }, @@ -14019,9 +15837,6 @@ } ], "operationId": "UpdateCall", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14098,6 +15913,47 @@ "description": "The maximum duration of the call in seconds. Constraints depend on account and configuration." } } + }, + "examples": { + "update": { + "value": { + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "Method": "GET", + "Status": "completed", + "StatusCallback": "https://example.com", + "StatusCallbackUrl": "https://example.com", + "StatusCallbackMethod": "GET", + "Url": "https://example.com" + } + }, + "cancel": { + "value": { + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "Method": "GET", + "Status": "canceled", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "Url": "https://example.com" + } + }, + "posttwiml": { + "value": { + "FallbackMethod": "GET", + "FallbackUrl": "https://example.com", + "Method": "GET", + "Status": "canceled", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "Twiml": "Enjoy" + } + }, + "updatetimelimit": { + "value": { + "TimeLimit": 600 + } + } } } } @@ -14116,8 +15972,8 @@ "request", "response" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of all events for a call.", @@ -14179,44 +16035,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCallEventResponse", - "properties": { - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_event" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallEventResponse", + "properties": { + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call.call_event" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "events": [ + { + "request": { + "method": "POST", + "url": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "parameters": { + "status_callback_method": "POST", + "twiml": "Hi!", + "trim": "trim-silence", + "timeout": "55", + "method": "POST", + "from": "+987654321", + "to": "+123456789", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "machine_detection_timeout": "0" + } + }, + "response": { + "response_code": 201, + "request_duration": 50, + "content_type": "application/json", + "response_body": "{\"sid\": \"CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "date_created": "Tue, 11 Aug 2020 17:44:08 +0000" + } + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "events": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0" } } } @@ -14230,10 +16148,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallEvent" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Feedback.json": { @@ -14249,8 +16164,8 @@ "quality_score", "date_created" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch a Feedback resource from a call", @@ -14286,6 +16201,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 20 Aug 2015 21:45:46 +0000", + "date_updated": "Thu, 20 Aug 2015 21:45:46 +0000", + "issues": [ + "imperfect-audio", + "post-dial-delay" + ], + "quality_score": 1, + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -14297,10 +16227,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallFeedback", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallFeedback" }, "post": { "description": "Update a Feedback resource for a call", @@ -14333,6 +16260,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 20 Aug 2015 21:45:46 +0000", + "date_updated": "Thu, 20 Aug 2015 21:45:46 +0000", + "issues": [ + "audio-latency" + ], + "quality_score": 2, + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -14345,9 +16286,6 @@ } ], "operationId": "UpdateCallFeedback", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14368,6 +16306,16 @@ "description": "One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`." } } + }, + "examples": { + "update": { + "value": { + "Issue": [ + "audio-latency" + ], + "QualityScore": 2 + } + } } } } @@ -14388,9 +16336,9 @@ "quality_score_average", "start_date" ], - "pathType": "list", "parent": "/Accounts/{AccountSid}/Calls.json", - "mountName": "feedback_summaries" + "mountName": "feedback_summaries", + "pathType": "list" }, "post": { "description": "Create a FeedbackSummary resource for a call", @@ -14414,6 +16362,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" + }, + "examples": { + "create": { + "value": { + "include_subaccounts": false, + "call_feedback_count": 729, + "quality_score_standard_deviation": "1.0", + "end_date": "2014-01-01", + "quality_score_median": "4.0", + "quality_score_average": "4.5", + "date_updated": "Tue, 31 Aug 2010 20:36:28 +0000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "call_count": 10200, + "sid": "FSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "start_date": "2014-01-01", + "issues": [ + { + "count": 45, + "description": "imperfect-audio", + "percentage_of_total_calls": "0.04%" + } + ] + } + } } } }, @@ -14426,9 +16400,6 @@ } ], "operationId": "CreateCallFeedbackSummary", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14473,6 +16444,17 @@ "StartDate", "EndDate" ] + }, + "examples": { + "create": { + "value": { + "EndDate": "2014-01-01", + "IncludeSubaccounts": "false", + "StartDate": "2014-01-01", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET" + } + } } } } @@ -14493,9 +16475,9 @@ "quality_score_average", "start_date" ], - "pathType": "instance", "parent": "/Accounts/{AccountSid}/Calls.json", - "mountName": "feedback_summaries" + "mountName": "feedback_summaries", + "pathType": "instance" }, "get": { "description": "Fetch a FeedbackSummary resource from a call", @@ -14531,6 +16513,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" + }, + "examples": { + "fetch": { + "value": { + "include_subaccounts": false, + "call_feedback_count": 729, + "quality_score_standard_deviation": "1.0", + "end_date": "2014-01-01", + "quality_score_median": "4.0", + "quality_score_average": "4.5", + "date_updated": "Tue, 31 Aug 2010 20:36:28 +0000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "call_count": 10200, + "sid": "FSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", + "start_date": "2014-01-01", + "issues": [ + { + "count": 45, + "description": "imperfect-audio", + "percentage_of_total_calls": "0.04%" + } + ] + } + } } } }, @@ -14542,10 +16550,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallFeedbackSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallFeedbackSummary" }, "delete": { "description": "Delete a FeedbackSummary resource from a call", @@ -14585,10 +16590,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCallFeedbackSummary", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCallFeedbackSummary" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json": { @@ -14605,8 +16607,8 @@ "error_code", "message_date" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -14654,6 +16656,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_notification-instance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 18 Aug 2015 08:46:56 +0000", + "date_updated": "Tue, 18 Aug 2015 08:46:57 +0000", + "error_code": "15003", + "log": "1", + "message_date": "Tue, 18 Aug 2015 08:46:56 +0000", + "message_text": "statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml", + "more_info": "https://www.twilio.com/docs/errors/15003", + "request_method": null, + "request_url": "", + "request_variables": "", + "response_body": "", + "response_headers": "", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -14665,10 +16690,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json": { @@ -14685,8 +16707,8 @@ "error_code", "message_date" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -14721,6 +16743,14 @@ "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + } } }, { @@ -14730,6 +16760,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -14783,44 +16821,98 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCallNotificationResponse", - "properties": { - "notifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_notification" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallNotificationResponse", + "properties": { + "notifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call.call_notification" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "notifications": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Tue, 18 Aug 2015 08:46:56 +0000", + "date_updated": "Tue, 18 Aug 2015 08:46:57 +0000", + "error_code": "15003", + "log": "1", + "message_date": "Tue, 18 Aug 2015 08:46:56 +0000", + "message_text": "statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml", + "more_info": "https://www.twilio.com/docs/errors/15003", + "request_method": null, + "request_url": "", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "next_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json" + } + }, + "readEmpty": { + "value": { + "notifications": [], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "next_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json" } } } @@ -14834,10 +16926,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallNotification", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json": { @@ -14855,8 +16944,8 @@ "start_time", "duration" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a recording for the call", @@ -14892,6 +16981,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:34 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": null, + "price_unit": null, + "duration": null, + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartCallRecordingAPI", + "status": "in-progress", + "error_code": null, + "encryption_details": null, + "track": "both", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -14904,9 +17017,6 @@ } ], "operationId": "CreateCallRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14952,6 +17062,23 @@ "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio." } } + }, + "examples": { + "create": { + "value": { + "RecordingStatusCallbackEvent": [ + "in-progress completed failed" + ], + "RecordingStatusCallback": "https://example.com", + "RecordingStatusCallbackMethod": "GET", + "Trim": "do-not-trim", + "RecordingChannels": "dual", + "RecordingTrack": "both", + "PlayBeep": true, + "Transcribe": true, + "TranscriptionConfiguration": "JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -14991,6 +17118,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -15000,6 +17135,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } } }, { @@ -15009,6 +17152,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -15044,44 +17195,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListCallRecordingResponse", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListCallRecordingResponse", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "source": "StartCallRecordingAPI", + "status": "completed", + "track": "both", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" } } } @@ -15095,10 +17308,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json": { @@ -15116,8 +17326,8 @@ "start_time", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "post": { "description": "Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current active recording.", @@ -15162,6 +17372,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:36 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": null, + "price_unit": null, + "duration": null, + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartCallRecordingAPI", + "status": "paused", + "error_code": null, + "encryption_details": null, + "track": "both", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15174,9 +17408,6 @@ } ], "operationId": "UpdateCallRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15197,6 +17428,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "paused", + "PauseBehavior": "skip", + "PlayBeep": true + } + } } } } @@ -15248,6 +17488,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": null, + "channels": 2, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "source": "StartCallRecordingAPI", + "status": "completed", + "error_code": null, + "track": "both", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15259,10 +17527,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallRecording" }, "delete": { "description": "Delete a recording from your account", @@ -15314,10 +17579,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCallRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json": { @@ -15333,12 +17595,12 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { "participant": "{account_sid: account_sid, conference_sid: sid}", "recording": "{account_sid: account_sid, conference_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a conference", @@ -15374,6 +17636,84 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference" + }, + "examples": { + "fetchValidMixerZone": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "us1", + "status": "completed", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "last-participant-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchValidRegionInProgress": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "au1", + "status": "in-progress", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + }, + "fetchWithoutMixerZoneIntegerStatus": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "us1", + "status": "completed", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchUnknownMixerZoneInitIntegerStatus": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Fri, 18 Feb 2011 19:26:50 +0000", + "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000", + "friendly_name": "AHH YEAH", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "region": "unknown", + "status": "init", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -15385,10 +17725,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConference", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConference" }, "post": { "description": "", @@ -15421,6 +17758,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference" + }, + "examples": { + "updateEndConference": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 22 Aug 2011 20:58:45 +0000", + "date_updated": "Mon, 22 Aug 2011 20:58:46 +0000", + "friendly_name": null, + "region": "us1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": "conference-ended-via-api", + "call_sid_ending_conference": null + } + }, + "announceToConference": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": "Mon, 08 Feb 2021 20:58:45 +0000", + "date_updated": "Mon, 08 Feb 2021 20:58:46 +0000", + "friendly_name": "MyRoom", + "region": "us1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + } } } }, @@ -15433,9 +17810,6 @@ } ], "operationId": "UpdateConference", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15467,6 +17841,18 @@ "description": "The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`" } } + }, + "examples": { + "updateEndConference": { + "value": { + "Status": "completed" + } + }, + "announceToConference": { + "value": { + "AnnounceUrl": "http://www.myapp.com/announce" + } + } } } } @@ -15486,12 +17872,12 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { "participant": "{account_sid: account_sid, conference_sid: sid}", "recording": "{account_sid: account_sid, conference_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of conferences belonging to the account used to make the request", @@ -15515,6 +17901,20 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2008-01-03" + }, + "readNext": { + "value": "2008-01-03" + }, + "readPrevious": { + "value": "2008-01-03" + }, + "readDateCreatedEquals": { + "value": "2020-07-07" + } } }, { @@ -15524,6 +17924,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2008-01-01" + }, + "readNext": { + "value": "2008-01-01" + }, + "readPrevious": { + "value": "2008-01-01" + } } }, { @@ -15533,6 +17944,20 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2008-01-02" + }, + "readNext": { + "value": "2008-01-02" + }, + "readPrevious": { + "value": "2008-01-02" + }, + "readDateCreatedOnOrAfter": { + "value": "2021-01-01" + } } }, { @@ -15542,6 +17967,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-13" + }, + "readNext": { + "value": "2018-11-13" + }, + "readPrevious": { + "value": "2018-11-13" + } } }, { @@ -15551,6 +17987,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-11" + }, + "readNext": { + "value": "2018-11-11" + }, + "readPrevious": { + "value": "2018-11-11" + } } }, { @@ -15560,6 +18007,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-12" + }, + "readNext": { + "value": "2018-11-12" + }, + "readPrevious": { + "value": "2018-11-12" + } } }, { @@ -15568,6 +18026,20 @@ "description": "The string that identifies the Conference resources to read.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "friendly_name" + }, + "readNext": { + "value": "friendly_name" + }, + "readPrevious": { + "value": "friendly_name" + }, + "readMyroom": { + "value": "MyRoom" + } } }, { @@ -15577,6 +18049,20 @@ "schema": { "type": "string", "$ref": "#/components/schemas/conference_enum_status" + }, + "examples": { + "readEmpty": { + "value": "init" + }, + "readNext": { + "value": "in-progress" + }, + "readPrevious": { + "value": "in-progress" + }, + "readDateCreatedOnOrAfter": { + "value": "in-progress" + } } }, { @@ -15612,44 +18098,458 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListConferenceResponse", - "properties": { - "conferences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListConferenceResponse", + "properties": { + "conferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readEmpty": { + "value": { + "conferences": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0", + "page": 0, + "page_size": 50, + "start": 0, + "end": 0 + } + }, + "readNext": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFdddddddddddddddddddddddddddddddd", + "date_updated": "Thu, 01 Jan 2015 10:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 10:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "unknown", + "sid": "CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", + "date_updated": "Thu, 01 Jan 2015 09:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 09:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "us1", + "sid": "CFffffffffffffffffffffffffffffffff", + "date_updated": "Thu, 01 Jan 2015 08:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 08:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=2&PageToken=PACFffffffffffffffffffffffffffffffff", + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "page": 1, + "page_size": 3, + "start": 3, + "end": 5 + } + }, + "readPrevious": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Sat, 03 Jan 2015 11:23:45 +0000", + "date_created": "Sat, 03 Jan 2015 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "unknown", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Fri, 02 Jan 2015 11:23:45 +0000", + "date_created": "Fri, 02 Jan 2015 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "us1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Thu, 01 Jan 2015 11:23:45 +0000", + "date_created": "Thu, 01 Jan 2015 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd", + "page": 0, + "page_size": 3, + "start": 0, + "end": 2 + } + }, + "readMyroom": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Sun, 03 Jan 2021 11:23:45 +0000", + "date_created": "Sun, 03 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "completed", + "region": "us1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Sat, 02 Jan 2021 11:23:45 +0000", + "date_created": "Sat, 02 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "last-participant-left", + "call_sid_ending_conference": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + }, + { + "status": "completed", + "region": "ie1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "last-participant-left", + "call_sid_ending_conference": "CAcccccccccccccccccccccccccccccccc" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0", + "page": 0, + "page_size": 20, + "start": 0, + "end": 2 + } + }, + "readFull": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Fri, 03 Jul 2020 11:23:45 +0000", + "date_created": "Fri, 03 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "de1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Thu, 02 Jul 2020 11:23:45 +0000", + "date_created": "Thu, 02 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "completed", + "region": "br1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Wed, 01 Jul 2020 11:23:45 +0000", + "date_created": "Wed, 01 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "FRIEND", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0", + "page": 0, + "page_size": 3, + "start": 0, + "end": 2 + } + }, + "readDateCreatedEquals": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000", + "date_created": "Tue, 07 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "de1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000", + "date_created": "Tue, 07 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "completed", + "region": "br1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000", + "date_created": "Tue, 07 Jul 2020 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "FRIEND", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": "participant-with-end-conference-on-exit-left", + "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0", + "page": 0, + "page_size": 3, + "start": 0, + "end": 2 + } + }, + "readDateCreatedOnOrAfter": { + "value": { + "conferences": [ + { + "status": "in-progress", + "region": "jp1", + "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + }, + "friendly_name": "friendly_name", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "de1", + "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json" + }, + "friendly_name": "MyRoom", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + }, + { + "status": "in-progress", + "region": "br1", + "sid": "CFcccccccccccccccccccccccccccccccc", + "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000", + "date_created": "Fri, 01 Jan 2021 11:23:45 +0000", + "subresource_uris": { + "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json", + "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json" + }, + "friendly_name": "FRIEND", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json", + "api_version": "2010-04-01", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason_conference_ended": null, + "call_sid_ending_conference": null + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0", + "page": 0, + "page_size": 20, + "start": 0, + "end": 2 } } } @@ -15663,13 +18563,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListConference", - "x-maturity": [ - "GA" - ] + "operationId": "ListConference" } }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json": { + "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json": { "servers": [ { "url": "https://api.twilio.com" @@ -15684,16 +18581,16 @@ "start_time", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "list" }, - "post": { - "description": "Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.", + "get": { + "description": "Retrieve a list of recordings belonging to the call used to make the request", "parameters": [ { "name": "AccountSid", "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to update.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to read.", "schema": { "type": "string", "minLength": 34, @@ -15705,7 +18602,7 @@ { "name": "ConferenceSid", "in": "path", - "description": "The Conference SID that identifies the conference associated with the recording to update.", + "description": "The Conference SID that identifies the conference associated with the recording to read.", "schema": { "type": "string", "minLength": 34, @@ -15715,21 +18612,288 @@ "required": true }, { - "name": "Sid", - "in": "path", - "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use `Twilio.CURRENT` to reference the current active recording.", + "name": "DateCreated", + "in": "query", + "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "schema": { - "type": "string" + "type": "string", + "format": "date" }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } + } + }, + { + "name": "DateCreated<", + "in": "query", + "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", + "schema": { + "type": "string", + "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } + } + }, + { + "name": "DateCreated>", + "in": "query", + "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", + "schema": { + "type": "string", + "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListConferenceRecordingResponse", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + } + } + } + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListConferenceRecording" + } + }, + "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json": { + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "description": "Recordings of conferences", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "conference_sid", + "status", + "start_time", + "duration" + ], + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "instance" + }, + "post": { + "description": "Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.", + "parameters": [ + { + "name": "AccountSid", + "in": "path", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ConferenceSid", + "in": "path", + "description": "The Conference SID that identifies the conference associated with the recording to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CF[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use `Twilio.CURRENT` to reference the current active recording.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:39 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": null, + "price_unit": null, + "duration": null, + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "paused", + "error_code": null, + "encryption_details": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15742,9 +18906,6 @@ } ], "operationId": "UpdateConferenceRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15765,6 +18926,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "paused", + "PauseBehavior": "skip", + "PlayBeep": true + } + } } } } @@ -15816,6 +18986,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.0025", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -15827,10 +19024,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConferenceRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConferenceRecording" }, "delete": { "description": "Delete a recording from your account", @@ -15882,172 +19076,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConferenceRecording", - "x-maturity": [ - "GA" - ] - } - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json": { - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "description": "Recordings of conferences", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "conference_sid", - "status", - "start_time", - "duration" - ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" - }, - "get": { - "description": "Retrieve a list of recordings belonging to the call used to make the request", - "parameters": [ - { - "name": "AccountSid", - "in": "path", - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ConferenceSid", - "in": "path", - "description": "The Conference SID that identifies the conference associated with the recording to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DateCreated", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "DateCreated<", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "DateCreated>", - "in": "query", - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListConferenceRecordingResponse", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListConferenceRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConferenceRecording" } }, "/2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json": { @@ -16062,8 +19091,8 @@ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a connect-app", @@ -16099,6 +19128,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.connect_app" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "authorize_redirect_url": "http://example.com/redirect", + "company_name": "Twilio", + "deauthorize_callback_method": "GET", + "deauthorize_callback_url": "http://example.com/deauth", + "description": null, + "friendly_name": "Connect app for deletion", + "homepage_url": "http://example.com/home", + "permissions": [], + "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -16110,10 +19156,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectApp" }, "post": { "description": "Update a connect-app with the specified parameters", @@ -16149,6 +19192,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.connect_app" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "authorize_redirect_url": "http://example.com/redirect", + "company_name": "Twilio", + "deauthorize_callback_method": "GET", + "deauthorize_callback_url": "http://example.com/deauth", + "description": null, + "friendly_name": "Connect app for deletion", + "homepage_url": "http://example.com/home", + "permissions": [], + "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -16161,9 +19221,6 @@ } ], "operationId": "UpdateConnectApp", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16220,6 +19277,22 @@ "description": "A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`." } } + }, + "examples": { + "update": { + "value": { + "AuthorizeRedirectUrl": "https://example.com", + "CompanyName": "company_name", + "DeauthorizeCallbackMethod": "GET", + "DeauthorizeCallbackUrl": "https://example.com", + "Description": "description", + "FriendlyName": "friendly_name", + "HomepageUrl": "https://example.com", + "Permissions": [ + "get-all" + ] + } + } } } } @@ -16263,10 +19336,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/ConnectApps.json": { @@ -16281,8 +19351,8 @@ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of connect-apps belonging to the account used to make the request", @@ -16332,44 +19402,95 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListConnectAppResponse", - "properties": { - "connect_apps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.connect_app" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListConnectAppResponse", + "properties": { + "connect_apps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.connect_app" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "connect_apps": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "authorize_redirect_url": "http://example.com/redirect", + "company_name": "Twilio", + "deauthorize_callback_method": "GET", + "deauthorize_callback_url": "http://example.com/deauth", + "description": null, + "friendly_name": "Connect app for deletion", + "homepage_url": "http://example.com/home", + "permissions": [], + "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json" + } + }, + "readEmpty": { + "value": { + "connect_apps": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json" } } } @@ -16383,10 +19504,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json": { @@ -16402,8 +19520,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Addresses/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Addresses/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -16465,44 +19583,110 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListDependentPhoneNumberResponse", - "properties": { - "dependent_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.address.dependent_phone_number" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListDependentPhoneNumberResponse", + "properties": { + "dependent_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.address.dependent_phone_number" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "dependent_phone_numbers": [ + { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "3197004499318", + "phone_number": "+3197004499318", + "voice_url": null, + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": "POST", + "voice_caller_id_lookup": false, + "date_created": "Thu, 23 Feb 2017 10:26:31 -0800", + "date_updated": "Thu, 23 Feb 2017 10:26:31 -0800", + "sms_url": "", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "address_requirements": "any", + "capabilities": { + "Voice": false, + "SMS": true, + "MMS": false + }, + "status_callback": "", + "status_callback_method": "POST", + "api_version": "2010-04-01", + "voice_application_sid": null, + "sms_application_sid": "", + "trunk_sid": null, + "emergency_status": "Inactive", + "emergency_address_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json" + } + }, + "readEmpty": { + "value": { + "dependent_phone_numbers": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json" } } } @@ -16516,10 +19700,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDependentPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListDependentPhoneNumber" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json": { @@ -16535,11 +19716,11 @@ "phone_number", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "assigned_add_on": "{account_sid: account_sid, resource_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "post": { "description": "Update an incoming-phone-number instance.", @@ -16575,6 +19756,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Inactive", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": true, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "voice_receive_mode": "voice", + "status": "in-use", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + } } } }, @@ -16587,9 +19816,6 @@ } ], "operationId": "UpdateIncomingPhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16766,6 +19992,34 @@ "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations." } } + }, + "examples": { + "update": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "EmergencyStatus": "Inactive", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "VoiceReceiveMode": "voice", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -16805,6 +20059,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "voice_receive_mode": "voice", + "status": "in-use", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + } } } }, @@ -16816,10 +20118,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIncomingPhoneNumber" }, "delete": { "description": "Delete a phone-numbers belonging to the account used to make the request.", @@ -16859,10 +20158,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIncomingPhoneNumber" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json": { @@ -16878,11 +20174,11 @@ "phone_number", "friendly_name" ], - "pathType": "list", "dependentProperties": { "assigned_add_on": "{account_sid: account_sid, resource_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of incoming-phone-numbers belonging to the account used to make the request.", @@ -16905,6 +20201,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -16913,6 +20217,14 @@ "description": "A string that identifies the IncomingPhoneNumber resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -16922,6 +20234,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -16965,44 +20285,126 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -17016,10 +20418,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumber" }, "post": { "description": "Purchase a phone-number for the account.", @@ -17043,6 +20442,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": false, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use", + "subresource_uris": { + "assigned_add_ons": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json" + } + } + } } } }, @@ -17055,9 +20502,6 @@ } ], "operationId": "CreateIncomingPhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17236,6 +20680,34 @@ "description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only)." } } + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -17256,7 +20728,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17264,11 +20736,11 @@ "friendly_name", "description" ], - "pathType": "instance", "dependentProperties": { "assigned_add_on_extension": "{account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an Add-on installation currently assigned to this Number.", @@ -17316,6 +20788,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + }, + "examples": { + "fetch": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "Thu, 07 Apr 2016 23:52:28 +0000", + "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "extensions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json" + } + } + } } } }, @@ -17327,10 +20820,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIncomingPhoneNumberAssignedAddOn" }, "delete": { "description": "Remove the assignment of an Add-on installation from the Number specified.", @@ -17382,10 +20872,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteIncomingPhoneNumberAssignedAddOn" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json": { @@ -17394,7 +20881,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17402,11 +20889,11 @@ "friendly_name", "description" ], - "pathType": "list", "dependentProperties": { "assigned_add_on_extension": "{account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of Add-on installations currently assigned to this Number.", @@ -17460,52 +20947,107 @@ "description": "The page token. This is provided by the API.", "schema": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberAssignedAddOnResponse", - "properties": { - "assigned_add_ons": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberAssignedAddOnResponse", + "properties": { + "assigned_add_ons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + } + } + } + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "assigned_add_ons": [ + { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "Thu, 07 Apr 2016 23:52:28 +0000", + "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "extensions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "assigned_add_ons": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0" } } } @@ -17519,10 +21061,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIncomingPhoneNumberAssignedAddOn" }, "post": { "description": "Assign an Add-on installation to the Number specified.", @@ -17558,6 +21097,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + }, + "examples": { + "create": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "Thu, 07 Apr 2016 23:52:28 +0000", + "date_updated": "Thu, 07 Apr 2016 23:52:28 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "extensions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json" + } + } + } } } }, @@ -17570,9 +21130,6 @@ } ], "operationId": "CreateIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17591,6 +21148,13 @@ "required": [ "InstalledAddOnSid" ] + }, + "examples": { + "create": { + "value": { + "InstalledAddOnSid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -17603,7 +21167,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17611,9 +21175,9 @@ "friendly_name", "product_name" ], - "pathType": "instance", "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json", - "className": "assigned_add_on_extension" + "className": "assigned_add_on_extension", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Assigned Add-on.", @@ -17673,6 +21237,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "enabled": true + } + } } } }, @@ -17684,10 +21263,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json": { @@ -17696,7 +21272,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17704,9 +21280,9 @@ "friendly_name", "product_name" ], - "pathType": "list", "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json", - "className": "assigned_add_on_extension" + "className": "assigned_add_on_extension", + "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Assigned Add-on.", @@ -17780,44 +21356,93 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse", - "properties": { - "extensions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse", + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "extensions": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0" } } } @@ -17831,10 +21456,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json": { @@ -17850,8 +21472,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", @@ -17874,6 +21496,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -17882,6 +21512,14 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -17891,6 +21529,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -17934,44 +21580,122 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberLocalResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberLocalResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -17985,10 +21709,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberLocal", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberLocal" }, "post": { "description": "", @@ -18012,6 +21733,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": true, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + } } } }, @@ -18024,9 +21790,6 @@ } ], "operationId": "CreateIncomingPhoneNumberLocal", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18204,6 +21967,34 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18223,8 +22014,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", @@ -18247,6 +22038,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -18255,6 +22054,14 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -18264,6 +22071,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -18307,44 +22122,122 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberMobileResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberMobileResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -18358,10 +22251,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberMobile", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberMobile" }, "post": { "description": "", @@ -18385,6 +22275,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": true, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + } } } }, @@ -18397,9 +22332,6 @@ } ], "operationId": "CreateIncomingPhoneNumberMobile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18577,6 +22509,34 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18596,8 +22556,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", @@ -18620,6 +22580,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -18628,6 +22596,14 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -18637,6 +22613,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -18680,44 +22664,122 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListIncomingPhoneNumberTollFreeResponse", - "properties": { - "incoming_phone_numbers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListIncomingPhoneNumberTollFreeResponse", + "properties": { + "incoming_phone_numbers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": null, + "capabilities": { + "mms": true, + "sms": false, + "voice": true + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "(808) 925-5327", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "", + "sms_fallback_method": "POST", + "sms_fallback_url": "", + "sms_method": "POST", + "sms_url": "", + "status_callback": "", + "status_callback_method": "POST", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "", + "voice_caller_id_lookup": false, + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_url": null, + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0", + "incoming_phone_numbers": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0" } } } @@ -18731,10 +22793,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberTollFree", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberTollFree" }, "post": { "description": "", @@ -18758,6 +22817,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "beta": false, + "capabilities": { + "voice": true, + "sms": false, + "mms": true, + "fax": false + }, + "date_created": "Thu, 30 Jul 2015 23:19:04 +0000", + "date_updated": "Thu, 30 Jul 2015 23:19:04 +0000", + "emergency_status": "Active", + "emergency_address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_address_status": "registered", + "friendly_name": "friendly_name", + "identity_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "origin": "origin", + "phone_number": "+18089255327", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "GET", + "sms_fallback_url": "https://example.com", + "sms_method": "GET", + "sms_url": "https://example.com", + "status_callback": "https://example.com", + "status_callback_method": "GET", + "trunk_sid": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_caller_id_lookup": true, + "voice_fallback_method": "GET", + "voice_fallback_url": "https://example.com", + "voice_method": "GET", + "voice_url": "https://example.com", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_receive_mode": "voice", + "status": "in-use" + } + } } } }, @@ -18770,9 +22874,6 @@ } ], "operationId": "CreateIncomingPhoneNumberTollFree", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18950,6 +23051,34 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ApiVersion": "api_version", + "AreaCode": "area_code", + "EmergencyStatus": "Active", + "EmergencyAddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "IdentitySid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18089255327", + "SmsApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com", + "StatusCallback": "https://example.com", + "StatusCallbackMethod": "GET", + "VoiceApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VoiceCallerIdLookup": "true", + "VoiceFallbackMethod": "GET", + "VoiceFallbackUrl": "https://example.com", + "VoiceMethod": "GET", + "VoiceUrl": "https://example.com", + "BundleSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18969,8 +23098,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -19006,6 +23135,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.key" + }, + "examples": { + "fetch": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -19017,10 +23156,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchKey" }, "post": { "description": "", @@ -19056,6 +23192,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.key" + }, + "examples": { + "update": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -19068,9 +23214,6 @@ } ], "operationId": "UpdateKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19083,6 +23226,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -19126,10 +23276,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteKey" } }, "/2010-04-01/Accounts/{AccountSid}/Keys.json": { @@ -19145,8 +23292,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -19196,44 +23343,88 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListKeyResponse", - "properties": { - "keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.key" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListKeyResponse", + "properties": { + "keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.key" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "keys": [ + { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readEmpty": { + "value": { + "keys": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -19247,10 +23438,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListKey" }, "post": { "description": "", @@ -19274,6 +23462,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.new_key" + }, + "examples": { + "create": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000", + "secret": "foobar" + } + } } } }, @@ -19286,9 +23485,6 @@ } ], "operationId": "CreateNewKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19301,6 +23497,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -19323,8 +23526,8 @@ "parent_sid", "content_type" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Delete media from your account. Once delete, you will no longer be billed", @@ -19376,10 +23579,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMedia", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMedia" }, "get": { "description": "Fetch a single media instance belonging to the account used to make the request", @@ -19427,6 +23627,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message.media" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "image/jpeg", + "date_created": "Sun, 16 Aug 2015 15:53:54 +0000", + "date_updated": "Sun, 16 Aug 2015 15:53:55 +0000", + "parent_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -19438,10 +23651,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMedia", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMedia" } }, "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json": { @@ -19457,8 +23667,8 @@ "parent_sid", "content_type" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of Media resources belonging to the account used to make the request", @@ -19494,6 +23704,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -19503,6 +23721,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } } }, { @@ -19512,6 +23738,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -19547,44 +23781,97 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListMediaResponse", - "properties": { - "media_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.message.media" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListMediaResponse", + "properties": { + "media_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.message.media" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "media_list": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "image/jpeg", + "date_created": "Sun, 16 Aug 2015 15:53:54 +0000", + "date_updated": "Sun, 16 Aug 2015 15:53:55 +0000", + "parent_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0", + "media_list": [], + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0" } } } @@ -19598,10 +23885,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMedia", - "x-maturity": [ - "GA" - ] + "operationId": "ListMedia" } }, "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json": { @@ -19618,8 +23902,8 @@ "position", "wait_time" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Queues/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Queues/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch a specific member from the queue", @@ -19664,6 +23948,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue.member" + }, + "examples": { + "fetch": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + }, + "fetchFront": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + } } } }, @@ -19675,10 +23981,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "post": { "description": "Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL", @@ -19723,6 +24026,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue.member" + }, + "examples": { + "update": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Thu, 06 Dec 2018 18:42:47 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + }, + "dequeueFront": { + "value": { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 143 + } + } } } }, @@ -19735,9 +24060,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19767,6 +24089,20 @@ "required": [ "Url" ] + }, + "examples": { + "update": { + "value": { + "Method": "GET", + "Url": "https://example.com" + } + }, + "dequeueFront": { + "value": { + "Method": "GET", + "Url": "https://example.com" + } + } } } } @@ -19787,8 +24123,8 @@ "position", "wait_time" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Queues/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Queues/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve the members of the queue", @@ -19850,44 +24186,90 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListMemberResponse", - "properties": { - "queue_members": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListMemberResponse", + "properties": { + "queue_members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.queue.member" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "queue_members": [ + { + "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_enqueued": "Mon, 17 Dec 2018 18:36:39 +0000", + "position": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "wait_time": 124 + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?Page=0&PageSize=50", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "queue_members": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" } } } @@ -19901,10 +24283,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/2010-04-01/Accounts/{AccountSid}/Messages.json": { @@ -19923,12 +24302,12 @@ "direction", "date_sent" ], - "pathType": "list", "dependentProperties": { "media": "{account_sid: account_sid, message_sid: sid}", "feedback": "{account_sid: account_sid, message_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Send a message from the account used to make the request", @@ -19952,6 +24331,200 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Thu, 30 Jul 2015 20:12:31 +0000", + "date_sent": "Thu, 30 Jul 2015 20:12:33 +0000", + "date_updated": "Thu, 30 Jul 2015 20:12:33 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+14155552345", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": null, + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+14155552345", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWoService": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Thu, 30 Jul 2015 20:12:31 +0000", + "date_sent": "Thu, 30 Jul 2015 20:12:33 +0000", + "date_updated": "Thu, 30 Jul 2015 20:12:33 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+14155552345", + "messaging_service_sid": null, + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": null, + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": {}, + "to": "+14155552345", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithMessagingService": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Thu, 30 Jul 2015 20:12:31 +0000", + "date_sent": "Thu, 30 Jul 2015 20:12:33 +0000", + "date_updated": "Thu, 30 Jul 2015 20:12:33 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": null, + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": null, + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": {}, + "to": "+14155552345", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithQueuedStatus": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Thu, 30 Jul 2015 20:12:31 +0000", + "date_sent": "Thu, 30 Jul 2015 20:12:33 +0000", + "date_updated": "Thu, 30 Jul 2015 20:12:33 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+14155552345", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": null, + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": {}, + "to": "+14155552345", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createScheduledMessageSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Mon, 29 Nov 2021 22:40:10 +0000", + "date_sent": null, + "date_updated": "Mon, 29 Nov 2021 22:40:10 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": null, + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "num_media": "0", + "num_segments": "0", + "price": null, + "price_unit": null, + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": {}, + "to": "+15558675310", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createScheduledMessageMms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Mon, 29 Nov 2021 22:40:10 +0000", + "date_sent": null, + "date_updated": "Mon, 29 Nov 2021 22:40:10 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": null, + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "num_media": "1", + "num_segments": "1", + "price": null, + "price_unit": null, + "sid": "MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": {}, + "to": "+15558675310", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createScheduledMessageWhatsapp": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello! \ud83d\udc4d", + "date_created": "Mon, 29 Nov 2021 22:40:10 +0000", + "date_sent": null, + "date_updated": "Mon, 29 Nov 2021 22:40:10 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": null, + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "num_media": "0", + "num_segments": "0", + "price": null, + "price_unit": null, + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": {}, + "to": "whatsapp:+15558675310", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -19964,9 +24537,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20050,13 +24620,6 @@ "type": "boolean", "description": "If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media." }, - "ContentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HX[0-9a-fA-F]{32}$", - "description": "The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized." - }, "ContentVariables": { "type": "string", "description": "Key-value pairs of variable names to substitution values, used alongside a content_sid. If not specified, Content API will default to the default variables defined at create time." @@ -20084,11 +24647,138 @@ "format": "uri" }, "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada." + }, + "ContentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "description": "The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized." } }, "required": [ "To" ] + }, + "examples": { + "create": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Body": "Hello! \ud83d\udc4d", + "From": "+14155552345", + "MediaUrl": [ + "https://c1.staticflickr.com/3/2899/14341091933_1e92e62d12_b.jpg" + ], + "PersistentAction": [ + "mailto:test@example.com" + ], + "TransientAction": [ + "reply:Tell me more" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345", + "Title": "An exciting example", + "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", + "TrafficType": "free", + "Tags": "{\"campaign_name\": \"Spring Sale 2022\",\"message_type\": \"cart_abandoned\"}" + } + }, + "createWoService": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Body": "Hello! \ud83d\udc4d", + "From": "+14155552345", + "MediaUrl": [ + "https://example.com" + ], + "PersistentAction": [ + "mailto:test@example.com" + ], + "TransientAction": [ + "reply:Tell me more" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345", + "Title": "An exciting example", + "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", + "TrafficType": "free" + } + }, + "createWithMessagingService": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Body": "Hello! \ud83d\udc4d", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MediaUrl": [ + "https://example.com" + ], + "PersistentAction": [ + "mailto:test@example.com" + ], + "TransientAction": [ + "reply:Tell me more" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345", + "Title": "An exciting example", + "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", + "ContentSid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ContentVariables": "{\"1\": \"name\",\"2\": \"owl.png\"}", + "TrafficType": "free" + } + }, + "createWithQueuedStatus": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Body": "Hello! \ud83d\udc4d", + "From": "+14155552345", + "MediaUrl": [ + "https://example.com" + ], + "PersistentAction": [ + "mailto:test@example.com" + ], + "TransientAction": [ + "reply:Tell me more" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345", + "Title": "An exciting example", + "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", + "TrafficType": "free" + } + }, + "createScheduledMessageSms": { + "value": { + "Body": "Hello! \ud83d\udc4d", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ScheduleType": "fixed", + "SendAt": "2021-11-29T23:50:00Z", + "StatusCallback": "https://example.com", + "To": "+15558675310" + } + }, + "createScheduledMessageMms": { + "value": { + "Body": "Hello! \ud83d\udc4d", + "MediaUrl": "https://example.com", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ScheduleType": "fixed", + "SendAt": "2021-11-29T23:50:00Z", + "StatusCallback": "https://example.com", + "To": "+15558675310" + } + }, + "createScheduledMessageWhatsapp": { + "value": { + "Body": "Hello! \ud83d\udc4d", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ScheduleType": "fixed", + "SendAt": "2021-11-29T23:50:00Z", + "StatusCallback": "https://example.com", + "To": "whatsapp:+15558675310" + } + } } } } @@ -20101,7 +24791,8 @@ ], [ "body", - "media_url" + "media_url", + "content_sid" ] ] } @@ -20128,6 +24819,29 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFullPage1": { + "value": "+123456789" + }, + "readEmptySentdateLess": { + "value": "+123456789" + }, + "readEmptySentdateEquals": { + "value": "+123456789" + }, + "readEmptySentdateGreater": { + "value": "+123456789" + }, + "readEmptySentdateGreaterFormat1": { + "value": "+123456789" + }, + "readEmptySentdateGreaterFormat2": { + "value": "+123456789" + }, + "readEmptySentdateGreaterFormat3": { + "value": "+123456789" + } } }, { @@ -20137,6 +24851,29 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFullPage1": { + "value": "+987654321" + }, + "readEmptySentdateLess": { + "value": "+987654321" + }, + "readEmptySentdateEquals": { + "value": "+987654321" + }, + "readEmptySentdateGreater": { + "value": "+987654321" + }, + "readEmptySentdateGreaterFormat1": { + "value": "+987654321" + }, + "readEmptySentdateGreaterFormat2": { + "value": "+987654321" + }, + "readEmptySentdateGreaterFormat3": { + "value": "+987654321" + } } }, { @@ -20146,6 +24883,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptySentdateEquals": { + "value": "2008-01-02" + } } }, { @@ -20155,6 +24897,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptySentdateLess": { + "value": "2008-01-02" + } } }, { @@ -20164,6 +24911,23 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2008-01-02" + }, + "readEmptySentdateGreater": { + "value": "2008-01-02" + }, + "readEmptySentdateGreaterFormat1": { + "value": "06/11/2019 22:05:25 MST" + }, + "readEmptySentdateGreaterFormat2": { + "value": "2019-06-11 22:05:25.000" + }, + "readEmptySentdateGreaterFormat3": { + "value": "Wed, 19 Jun 2019 22:04:00 -0000" + } } }, { @@ -20199,44 +24963,205 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListMessageResponse", - "properties": { - "messages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.message" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListMessageResponse", + "properties": { + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.message" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFullPage1": { + "value": { + "end": 1, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=1&PageToken=PAMMc26223853f8c46b4ab7dfaa6abba0a26", + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "messages": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "testing", + "date_created": "Fri, 24 May 2019 17:44:46 +0000", + "date_sent": "Fri, 24 May 2019 17:44:50 +0000", + "date_updated": "Fri, 24 May 2019 17:44:50 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+12019235161", + "messaging_service_sid": null, + "num_media": "0", + "num_segments": "1", + "price": "-0.00750", + "price_unit": "USD", + "sid": "SMded05904ccb347238880ca9264e8fe1c", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Feedback.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "look mom I have media!", + "date_created": "Fri, 24 May 2019 17:44:46 +0000", + "date_sent": "Fri, 24 May 2019 17:44:49 +0000", + "date_updated": "Fri, 24 May 2019 17:44:49 +0000", + "direction": "inbound", + "error_code": 30004, + "error_message": "Message blocked", + "from": "+12019235161", + "messaging_service_sid": null, + "num_media": "3", + "num_segments": "1", + "price": "-0.00750", + "price_unit": "USD", + "sid": "MMc26223853f8c46b4ab7dfaa6abba0a26", + "status": "received", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Feedback.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26.json" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0" + } + }, + "readEmptySentdateLess": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0" + } + }, + "readEmptySentdateEquals": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreater": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreaterFormat1": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreaterFormat2": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0" + } + }, + "readEmptySentdateGreaterFormat3": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 25, + "previous_page_uri": null, + "messages": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0" } } } @@ -20250,10 +25175,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json": { @@ -20272,12 +25194,12 @@ "direction", "date_sent" ], - "pathType": "instance", "dependentProperties": { "media": "{account_sid: account_sid, message_sid: sid}", "feedback": "{account_sid: account_sid, message_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Deletes a message record from your account", @@ -20317,10 +25239,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "get": { "description": "Fetch a message belonging to the account used to make the request", @@ -20356,6 +25275,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "testing", + "date_created": "Fri, 24 May 2019 17:18:27 +0000", + "date_sent": "Fri, 24 May 2019 17:18:28 +0000", + "date_updated": "Fri, 24 May 2019 17:18:28 +0000", + "direction": "outbound-api", + "error_code": 30007, + "error_message": "Carrier violation", + "from": "+12019235161", + "messaging_service_sid": "MGdeadbeefdeadbeefdeadbeefdeadbeef", + "num_media": "0", + "num_segments": "1", + "price": "-0.00750", + "price_unit": "USD", + "sid": "SMb7c0a2ce80504485a6f653a7110836f5", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json" + }, + "tags": { + "campaign_name": "Spring Sale 2022", + "message_type": "cart_abandoned" + }, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json" + } + } } } }, @@ -20367,10 +25319,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "post": { "description": "To redact a message-body from a post-flight message record, post to the message instance resource with an empty body", @@ -20406,6 +25355,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message" + }, + "examples": { + "redactBody": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "", + "date_created": "Fri, 24 May 2019 17:18:27 +0000", + "date_sent": "Fri, 24 May 2019 17:18:28 +0000", + "date_updated": "Fri, 24 May 2019 17:18:28 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+12019235161", + "messaging_service_sid": "MGdeadbeefdeadbeefdeadbeefdeadbeef", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": "USD", + "sid": "SMb7c0a2ce80504485a6f653a7110836f5", + "status": "sent", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json" + }, + "tags": {}, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json" + } + }, + "cancelMessage": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "body": "Hello World!", + "date_created": "Fri, 24 May 2019 17:18:27 +0000", + "date_sent": null, + "date_updated": "Fri, 24 May 2019 18:18:28 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": null, + "messaging_service_sid": "MGdeadbeefdeadbeefdeadbeefdeadbeef", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": "USD", + "sid": "SMb7c0a2ce80504485a6f653a7110836f5", + "status": "canceled", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json", + "feedback": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json" + }, + "tags": {}, + "to": "+18182008801", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json" + } + } } } }, @@ -20418,9 +25425,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20438,6 +25442,18 @@ "description": "When set as `canceled`, allows a message cancelation request if a message has not yet been sent." } } + }, + "examples": { + "redactBody": { + "value": { + "Body": "" + } + }, + "cancelMessage": { + "value": { + "Status": "canceled" + } + } } } } @@ -20457,8 +25473,8 @@ "outcome", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "list" }, "post": { "description": "", @@ -20494,6 +25510,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.message.message_feedback" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "message_sid": "MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outcome": "confirmed", + "uri": "uri" + } + } } } }, @@ -20506,9 +25534,6 @@ } ], "operationId": "CreateMessageFeedback", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20522,6 +25547,13 @@ "description": "Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`." } } + }, + "examples": { + "create": { + "value": { + "Outcome": "confirmed" + } + } } } } @@ -20541,8 +25573,8 @@ "friendly_name", "secret" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new Signing Key for the account making the request.", @@ -20566,6 +25598,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.new_signing_key" + }, + "examples": { + "create": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000", + "secret": "foobar" + } + } } } }, @@ -20578,9 +25621,6 @@ } ], "operationId": "CreateNewSigningKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20593,6 +25633,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -20649,44 +25696,88 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSigningKeyResponse", - "properties": { - "signing_keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.signing_key" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSigningKeyResponse", + "properties": { + "signing_keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.signing_key" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "signing_keys": [ + { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readEmpty": { + "value": { + "signing_keys": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -20700,10 +25791,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListSigningKey" } }, "/2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json": { @@ -20720,8 +25808,8 @@ "error_code", "message_date" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch a notification belonging to the account used to make the request", @@ -20757,6 +25845,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.notification-instance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 13 Sep 2010 20:02:01 +0000", + "date_updated": "Mon, 13 Sep 2010 20:02:01 +0000", + "error_code": "11200", + "log": "0", + "message_date": "Mon, 13 Sep 2010 20:02:00 +0000", + "message_text": "EmailNotification=false&LogLevel=ERROR&sourceComponent=12000&Msg=&httpResponse=500&ErrorCode=11200&url=http%3A%2F%2Fvoiceforms4000.appspot.com%2Ftwiml", + "more_info": "http://www.twilio.com/docs/errors/11200", + "request_method": "get", + "request_url": "https://voiceforms4000.appspot.com/twiml/9436/question/0", + "request_variables": "AccountSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CallStatus=in-progress&ToZip=94937&ToCity=INVERNESS&ToState=CA&Called=%2B14156694923&To=%2B14156694923&ToCountry=US&CalledZip=94937&Direction=inbound&ApiVersion=2010-04-01&Caller=%2B17378742833&CalledCity=INVERNESS&CalledCountry=US&CallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CalledState=CA&From=%2B17378742833", + "response_body": "Response body from your webhook URL as a string.", + "response_headers": "Date=Mon%2C+13+Sep+2010+20%3A02%3A00+GMT&Content-Length=466&Connection=close&Content-Type=text%2Fhtml%3B+charset%3DUTF-8&Server=Google+Frontend", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -20768,10 +25879,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Notifications.json": { @@ -20788,8 +25896,8 @@ "error_code", "message_date" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of notifications belonging to the account used to make the request", @@ -20812,6 +25920,14 @@ "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + } } }, { @@ -20821,6 +25937,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -20874,44 +25998,98 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListNotificationResponse", - "properties": { - "notifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.notification" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListNotificationResponse", + "properties": { + "notifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.notification" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "previous_page_uri": null, + "next_page_uri": null, + "notifications": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Apr 2015 16:47:33 +0000", + "date_updated": "Thu, 30 Apr 2015 16:47:35 +0000", + "error_code": "21609", + "log": "1", + "message_date": "Thu, 30 Apr 2015 16:47:32 +0000", + "message_text": "LogLevel=WARN&invalidStatusCallbackUrl=&Msg=Invalid+Url+for+callSid%3A+CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+invalid+statusCallbackUrl%3A+&ErrorCode=21609", + "more_info": "https://www.twilio.com/docs/errors/21609", + "request_method": null, + "request_url": "", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "page": 0, + "page_size": 1, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0", + "next_page_uri": null, + "notifications": [], + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0" } } } @@ -20925,10 +26103,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNotification", - "x-maturity": [ - "GA" - ] + "operationId": "ListNotification" } }, "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json": { @@ -20944,8 +26119,8 @@ "phone_number", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an outgoing-caller-id belonging to the account used to make the request", @@ -20981,6 +26156,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "(415) 867-5309", + "phone_number": "+141586753096", + "date_created": "Fri, 21 Aug 2009 00:11:24 +0000", + "date_updated": "Fri, 21 Aug 2009 00:11:24 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -20992,10 +26180,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOutgoingCallerId" }, "post": { "description": "Updates the caller-id", @@ -21031,6 +26216,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 21 Aug 2009 00:11:24 +0000", + "date_updated": "Fri, 21 Aug 2009 00:11:24 +0000", + "friendly_name": "friendly_name", + "phone_number": "+141586753096", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21043,9 +26241,6 @@ } ], "operationId": "UpdateOutgoingCallerId", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21058,6 +26253,13 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -21101,10 +26303,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteOutgoingCallerId" } }, "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json": { @@ -21120,8 +26319,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of outgoing-caller-ids belonging to the account used to make the request", @@ -21188,44 +26387,91 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListOutgoingCallerIdResponse", - "properties": { - "outgoing_caller_ids": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListOutgoingCallerIdResponse", + "properties": { + "outgoing_caller_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0", + "next_page_uri": null, + "outgoing_caller_ids": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 21 Aug 2009 00:11:24 +0000", + "date_updated": "Fri, 21 Aug 2009 00:11:24 +0000", + "friendly_name": "(415) 867-5309", + "phone_number": "+141586753096", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0", + "next_page_uri": null, + "outgoing_caller_ids": [], + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0" } } } @@ -21239,10 +26485,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "ListOutgoingCallerId" }, "post": { "description": "", @@ -21266,6 +26509,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.validation_request" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "phone_number": "+18001234567", + "validation_code": "111111" + } + } } } }, @@ -21278,9 +26532,6 @@ } ], "operationId": "CreateValidationRequest", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21327,6 +26578,18 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "CallDelay": 100, + "Extension": "extension", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18001234567", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "GET" + } + } } } } @@ -21351,8 +26614,8 @@ "muted", "hold" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a participant", @@ -21397,6 +26660,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "fetchByLabel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21408,10 +26709,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchParticipant" }, "post": { "description": "Update the properties of the participant", @@ -21456,6 +26754,116 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "examples": { + "muteParticipant": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "muteParticipantByLabel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "holdParticipantWithMusic": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": true, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "announceToParticipant": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "modifyParticipant": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "complete", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "modifyParticipantByLabel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "complete", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21468,9 +26876,6 @@ } ], "operationId": "UpdateParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21560,6 +26965,41 @@ "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`." } } + }, + "examples": { + "muteParticipant": { + "value": { + "Muted": "true" + } + }, + "muteParticipantByLabel": { + "value": { + "Muted": "true" + } + }, + "holdParticipantWithMusic": { + "value": { + "Hold": "true", + "HoldUrl": "http://www.myapp.com/hold" + } + }, + "announceToParticipant": { + "value": { + "AnnounceUrl": "http://www.myapp.com/announce" + } + }, + "modifyParticipant": { + "value": { + "Coaching": true, + "CallSidToCoach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + }, + "modifyParticipantByLabel": { + "value": { + "Coaching": true, + "CallSidToCoach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } @@ -21612,10 +27052,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteParticipant" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json": { @@ -21633,8 +27070,8 @@ "muted", "hold" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "list" }, "post": { "description": "", @@ -21667,6 +27104,206 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" + }, + "examples": { + "createWithSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithSidAsCoach": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithNonE164Number": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameJitterBufferSize": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameByoc": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameCallerId": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "label": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameReason": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFriendlyNameRecordingTrack": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFromToClient": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithFromToSip": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "customer", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": false, + "hold": false, + "status": "queued", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -21679,9 +27316,6 @@ } ], "operationId": "CreateParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21962,6 +27596,194 @@ "From", "To" ] + }, + "examples": { + "createWithSid": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "Label": "customer", + "EarlyMedia": true, + "Beep": "onEnter", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "Trim": "do-not-trim", + "TimeLimit": 3600, + "MachineDetection": "enable", + "MachineDetectionTimeout": 15, + "MachineDetectionSpeechThreshold": 3000, + "MachineDetectionSpeechEndThreshold": 3000, + "MachineDetectionSilenceTimeout": 3000, + "AmdStatusCallback": "http://statuscallback.com", + "AmdStatusCallbackMethod": "POST", + "MachineDetectionEngine": "Lumenvox", + "MachineDetectionMinWordLength": 100, + "MachineDetectionMaxWordLength": 5000, + "MachineDetectionWordsSilence": 50, + "MachineDetectionMaxNumOfWords": 5, + "MachineDetectionSilenceThreshold": 256 + } + }, + "createWithFriendlyName": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "Label": "customer", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "Trim": "do-not-trim", + "TimeLimit": 3600, + "MachineDetection": "enable", + "MachineDetectionTimeout": 15, + "MachineDetectionSpeechThreshold": 3000, + "MachineDetectionSpeechEndThreshold": 3000, + "MachineDetectionSilenceTimeout": 3000, + "AmdStatusCallback": "http://statuscallback.com", + "AmdStatusCallbackMethod": "POST" + } + }, + "createWithSidAsCoach": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "EarlyMedia": true, + "Beep": "onEnter", + "Muted": false, + "CallSidToCoach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600 + } + }, + "createWithNonE164Number": { + "value": { + "From": "4405512345678", + "To": "4157663747", + "EarlyMedia": true, + "Beep": "onEnter", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600 + } + }, + "createWithFriendlyNameJitterBufferSize": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600, + "JitterBufferSize": "small" + } + }, + "createWithFriendlyNameByoc": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600, + "Byoc": "BYbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + }, + "createWithFriendlyNameCallerId": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "CallerId": "+17736772737", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600 + } + }, + "createWithFriendlyNameReason": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600, + "CallReason": "Reason for the call (Beta)" + } + }, + "createWithFriendlyNameRecordingTrack": { + "value": { + "From": "+17736774757", + "To": "+14157663747", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600, + "RecordingTrack": "inbound" + } + }, + "createWithFromToClient": { + "value": { + "From": "client:alice", + "To": "client:bob", + "Label": "customer", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600 + } + }, + "createWithFromToSip": { + "value": { + "From": "alice", + "To": "sip:bob@twilio.com", + "Label": "customer", + "EarlyMedia": true, + "Beep": "false", + "Muted": false, + "StatusCallback": "https://myapp.com/events", + "StatusCallbackMethod": "POST", + "StatusCallbackEvent": "ringing", + "Record": true, + "TimeLimit": 3600 + } + } } } } @@ -22000,6 +27822,17 @@ "description": "Whether to return only participants that are muted. Can be: `true` or `false`.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readNext": { + "value": "true" + }, + "readPrevious": { + "value": "true" + } } }, { @@ -22008,6 +27841,11 @@ "description": "Whether to return only participants that are on hold. Can be: `true` or `false`.", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + } } }, { @@ -22051,44 +27889,206 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListParticipantResponse", - "properties": { - "participants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListParticipantResponse", + "properties": { + "participants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference.participant" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readEmpty": { + "value": { + "participants": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0", + "next_page_uri": null, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0", + "page": 0, + "page_size": 50, + "end": 0, + "start": 0 + } + }, + "readFull": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "page": 0, + "page_size": 2, + "start": 0, + "end": 1 + } + }, + "readNext": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAcccccccccccccccccccccccccccccccc", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 17 Feb 2011 21:07:19 +0000", + "date_updated": "Thu, 17 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAcccccccccccccccccccccccccccccccc.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAdddddddddddddddddddddddddddddddd", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 16 Feb 2011 21:07:19 +0000", + "date_updated": "Wed, 16 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAdddddddddddddddddddddddddddddddd.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=2&PageToken=PACPdddddddddddddddddddddddddddddddd", + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "page": 1, + "page_size": 2, + "start": 2, + "end": 3 + } + }, + "readPrevious": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Sat, 19 Feb 2011 21:07:19 +0000", + "date_updated": "Sat, 19 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": true, + "call_sid_to_coach": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 18 Feb 2011 21:07:19 +0000", + "date_updated": "Fri, 18 Feb 2011 21:07:19 +0000", + "end_conference_on_exit": false, + "muted": true, + "hold": false, + "status": "connected", + "start_conference_on_enter": true, + "coaching": false, + "call_sid_to_coach": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc", + "page": 0, + "page_size": 2, + "start": 0, + "end": 1 } } } @@ -22102,10 +28102,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListParticipant" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json": { @@ -22119,8 +28116,8 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "create an instance of payments. This will start a new payments session", @@ -22156,6 +28153,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.payments" + }, + "examples": { + "startPaymentSessionSuccess": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -22168,9 +28177,6 @@ } ], "operationId": "CreatePayments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22250,6 +28256,24 @@ "IdempotencyKey", "StatusCallback" ] + }, + "examples": { + "startPaymentSessionSuccess": { + "value": { + "ChargeAmount": "12.00", + "Currency": "USD", + "Description": "api testing", + "IdempotencyKey": "abcd", + "Input": "dtmf", + "Parameter": "{'name':'foobar'}", + "PaymentConnector": "stripe_connector", + "PaymentMethod": "credit-card", + "PostalCode": true, + "SecurityCode": true, + "StatusCallback": "https://myapp.com/payments", + "ValidCardTypes": "visa amex" + } + } } } } @@ -22267,8 +28291,8 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "post": { "description": "update an instance of payments with different phases of payment flows.", @@ -22316,6 +28340,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.payments" + }, + "examples": { + "collectCreditCardNumber": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "collectCreditCardExpiryDate": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "completePayment": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000", + "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -22328,9 +28384,6 @@ } ], "operationId": "UpdatePayments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22362,6 +28415,29 @@ "IdempotencyKey", "StatusCallback" ] + }, + "examples": { + "collectCreditCardNumber": { + "value": { + "Capture": "payment-card-number", + "IdempotencyKey": "abcd", + "StatusCallback": "https://myapp.com/payments" + } + }, + "collectCreditCardExpiryDate": { + "value": { + "Capture": "expiration-date", + "IdempotencyKey": "abcd", + "StatusCallback": "https://myapp.com/payments" + } + }, + "completePayment": { + "value": { + "IdempotencyKey": "abcd", + "Status": "complete", + "StatusCallback": "https://myapp.com/payments" + } + } } } } @@ -22382,11 +28458,11 @@ "current_size", "average_wait_time" ], - "pathType": "instance", "dependentProperties": { "member": "{account_sid: account_sid, queue_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a queue identified by the QueueSid", @@ -22422,6 +28498,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + } } } }, @@ -22433,10 +28527,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchQueue", - "x-maturity": [ - "GA" - ] + "operationId": "FetchQueue" }, "post": { "description": "Update the queue with the new parameters", @@ -22472,6 +28563,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + } } } }, @@ -22484,9 +28593,6 @@ } ], "operationId": "UpdateQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22503,6 +28609,14 @@ "description": "The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "MaxSize": 1 + } + } } } } @@ -22546,10 +28660,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteQueue", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteQueue" } }, "/2010-04-01/Accounts/{AccountSid}/Queues.json": { @@ -22566,11 +28677,11 @@ "current_size", "average_wait_time" ], - "pathType": "list", "dependentProperties": { "member": "{account_sid: account_sid, queue_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of queues belonging to the account used to make the request", @@ -22620,44 +28731,96 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListQueueResponse", - "properties": { - "queues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.queue" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListQueueResponse", + "properties": { + "queues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.queue" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "queues": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "queues": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0" } } } @@ -22671,10 +28834,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListQueue", - "x-maturity": [ - "GA" - ] + "operationId": "ListQueue" }, "post": { "description": "Create a queue", @@ -22698,6 +28858,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "average_wait_time": 0, + "current_size": 0, + "date_created": "Tue, 04 Aug 2015 18:39:09 +0000", + "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000", + "friendly_name": "0.361280134646222", + "max_size": 100, + "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "members": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json" + } + } + } } } }, @@ -22710,9 +28888,6 @@ } ], "operationId": "CreateQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22732,6 +28907,14 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "MaxSize": 1 + } + } } } } @@ -22753,12 +28936,12 @@ "start_time", "duration" ], - "pathType": "instance", "dependentProperties": { "transcription": "{account_sid: account_sid, recording_sid: sid}", "add_on_result": "{account_sid: account_sid, reference_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a recording", @@ -22793,6 +28976,11 @@ "description": "A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.", "schema": { "type": "boolean" + }, + "examples": { + "fetchIncludeSoftDeleted": { + "value": "true" + } } } ], @@ -22802,6 +28990,68 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "-0.00250", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchIncludeSoftDeleted": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", + "price": "-0.00250", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "deleted", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -22813,10 +29063,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "delete": { "description": "Delete a recording from your account", @@ -22856,10 +29103,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings.json": { @@ -22877,12 +29121,12 @@ "start_time", "duration" ], - "pathType": "list", "dependentProperties": { "transcription": "{account_sid: account_sid, recording_sid: sid}", "add_on_result": "{account_sid: account_sid, reference_sid: sid}" }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of recordings belonging to the account used to make the request", @@ -22906,6 +29150,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-02" + } } }, { @@ -22915,6 +29170,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-01" + } } }, { @@ -22924,6 +29190,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-03" + } } }, { @@ -22954,6 +29231,11 @@ "description": "A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.", "schema": { "type": "boolean" + }, + "examples": { + "readIncludeSoftDeleted": { + "value": "True" + } } }, { @@ -22989,44 +29271,180 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingResponse", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingResponse", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 1, + "date_created": "Fri, 14 Oct 2016 21:56:34 +0000", + "date_updated": "Fri, 14 Oct 2016 21:56:38 +0000", + "start_time": "Fri, 14 Oct 2016 21:56:34 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "4", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "StartConferenceRecordingAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readIncludeSoftDeleted": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "OutboundAPI", + "status": "deleted", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "source": "OutboundAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0" } } } @@ -23040,10 +29458,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { @@ -23060,11 +29475,11 @@ "add_on_sid", "date_created" ], - "pathType": "instance", "dependentProperties": { "payload": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an AddOnResult", @@ -23112,6 +29527,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + }, + "examples": { + "fetch": { + "value": { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } + } + } } } }, @@ -23123,10 +29556,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingAddOnResult" }, "delete": { "description": "Delete a result and purge all associated Payloads", @@ -23178,10 +29608,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingAddOnResult" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { @@ -23198,11 +29625,11 @@ "add_on_sid", "date_created" ], - "pathType": "list", "dependentProperties": { "payload": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of results belonging to the recording", @@ -23264,44 +29691,96 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingAddOnResultResponse", - "properties": { - "add_on_results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingAddOnResultResponse", + "properties": { + "add_on_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "add_on_results": [ + { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "add_on_results": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0" } } } @@ -23315,10 +29794,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingAddOnResult" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { @@ -23334,11 +29810,11 @@ "label", "content_type" ], - "pathType": "instance", "dependentProperties": { - "api/v2010/recording_add_on_result_payload_data": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: sid}" + "data": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a result payload", @@ -23398,6 +29874,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + }, + "examples": { + "fetch": { + "value": { + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" + } + } + } } } }, @@ -23409,10 +29904,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingAddOnResultPayload" }, "delete": { "description": "Delete a payload from the result along with all associated Data", @@ -23476,10 +29968,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingAddOnResultPayload" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { @@ -23495,11 +29984,11 @@ "label", "content_type" ], - "pathType": "list", "dependentProperties": { - "api/v2010/recording_add_on_result_payload_data": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: sid}" + "data": "{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of payloads belonging to the AddOnResult", @@ -23566,51 +30055,104 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListRecordingAddOnResultPayloadResponse", - "properties": { - "payloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingAddOnResultPayloadResponse", + "properties": { + "payloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + } + } + } + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "payloads": [ + { + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "payloads": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" } } } @@ -23624,10 +30166,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingAddOnResultPayload" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { @@ -23644,8 +30183,8 @@ "status", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -23693,6 +30232,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Mon, 22 Aug 2011 20:58:44 +0000", + "date_updated": "Mon, 22 Aug 2011 20:58:44 +0000", + "duration": "10", + "price": "0.00000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "transcription_text": "THIS IS A TEST", + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -23704,10 +30262,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingTranscription" }, "delete": { "description": "", @@ -23759,10 +30314,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json": { @@ -23779,8 +30331,8 @@ "status", "duration" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -23842,44 +30394,103 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListRecordingTranscriptionResponse", - "properties": { - "transcriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListRecordingTranscriptionResponse", + "properties": { + "transcriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "transcriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Mon, 22 Aug 2011 20:58:44 +0000", + "date_updated": "Mon, 22 Aug 2011 20:58:44 +0000", + "duration": "10", + "price": "0.00000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "transcription_text": "THIS IS A TEST", + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "total": 1, + "transcriptions": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0" } } } @@ -23893,10 +30504,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json": { @@ -23912,8 +30520,8 @@ "short_code", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a short code", @@ -23949,6 +30557,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.short_code" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": null, + "date_updated": null, + "friendly_name": "API_CLUSTER_TEST_SHORT_CODE", + "short_code": "99990", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_url": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -23960,10 +30586,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "GA" - ] + "operationId": "FetchShortCode" }, "post": { "description": "Update a short code with the following parameters", @@ -23999,6 +30622,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.short_code" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": null, + "date_updated": null, + "friendly_name": "API_CLUSTER_TEST_SHORT_CODE", + "short_code": "99990", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_url": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -24011,9 +30652,6 @@ } ], "operationId": "UpdateShortCode", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24066,6 +30704,18 @@ "description": "The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`." } } + }, + "examples": { + "update": { + "value": { + "ApiVersion": "api_version", + "FriendlyName": "friendly_name", + "SmsFallbackMethod": "GET", + "SmsFallbackUrl": "https://example.com", + "SmsMethod": "GET", + "SmsUrl": "https://example.com" + } + } } } } @@ -24085,8 +30735,8 @@ "short_code", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of short-codes belonging to the account used to make the request", @@ -24109,6 +30759,14 @@ "description": "The string that identifies the ShortCode resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -24117,6 +30775,14 @@ "description": "Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "short_code" + }, + "readEmpty": { + "value": "short_code" + } } }, { @@ -24152,44 +30818,102 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListShortCodeResponse", - "properties": { - "short_codes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.short_code" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListShortCodeResponse", + "properties": { + "short_codes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.short_code" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "short_codes": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "date_created": null, + "date_updated": null, + "friendly_name": "API_CLUSTER_TEST_SHORT_CODE", + "short_code": "99990", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_fallback_method": "POST", + "sms_fallback_url": null, + "sms_method": "POST", + "sms_url": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50", + "next_page_uri": null, + "num_pages": 1, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "short_codes": [], + "start": 0, + "total": 1, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json" } } } @@ -24203,10 +30927,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "GA" - ] + "operationId": "ListShortCode" } }, "/2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json": { @@ -24215,14 +30936,14 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -24258,6 +30979,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.signing_key" + }, + "examples": { + "fetch": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -24269,10 +31000,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSigningKey" }, "post": { "description": "", @@ -24308,6 +31036,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.signing_key" + }, + "examples": { + "update": { + "value": { + "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "foo", + "date_created": "Mon, 13 Jun 2016 22:50:08 +0000", + "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000" + } + } } } }, @@ -24320,9 +31058,6 @@ } ], "operationId": "UpdateSigningKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24335,6 +31070,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "foo" + } + } } } } @@ -24378,10 +31120,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSigningKey" } }, "/2010-04-01/Accounts/{AccountSid}/SIP.json": { @@ -24390,11 +31129,11 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json": { @@ -24403,12 +31142,12 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json", - "className": "auth_types" + "className": "auth_types", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json": { @@ -24417,12 +31156,12 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json", - "className": "auth_type_calls" + "className": "auth_type_calls", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json": { @@ -24437,9 +31176,9 @@ "sid", "friendly_name" ], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json", - "className": "auth_calls_credential_list_mapping" + "className": "auth_calls_credential_list_mapping", + "pathType": "list" }, "post": { "description": "Create a new credential list mapping resource", @@ -24475,6 +31214,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -24487,9 +31237,6 @@ } ], "operationId": "CreateSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24508,6 +31255,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -24573,44 +31327,89 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipAuthCallsCredentialListMappingResponse", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipAuthCallsCredentialListMappingResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -24624,10 +31423,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthCallsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json": { @@ -24642,9 +31438,9 @@ "sid", "friendly_name" ], - "pathType": "instance", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json", - "className": "auth_calls_credential_list_mapping" + "className": "auth_calls_credential_list_mapping", + "pathType": "instance" }, "get": { "description": "Fetch a specific instance of a credential list mapping", @@ -24692,6 +31488,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -24703,10 +31510,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthCallsCredentialListMapping" }, "delete": { "description": "Delete a credential list mapping from the requested domain", @@ -24758,10 +31562,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthCallsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json": { @@ -24776,9 +31577,9 @@ "sid", "friendly_name" ], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json", - "className": "auth_calls_ip_access_control_list_mapping" + "className": "auth_calls_ip_access_control_list_mapping", + "pathType": "list" }, "post": { "description": "Create a new IP Access Control List mapping", @@ -24814,6 +31615,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -24826,9 +31638,6 @@ } ], "operationId": "CreateSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24847,6 +31656,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -24912,44 +31728,89 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipAuthCallsIpAccessControlListMappingResponse", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipAuthCallsIpAccessControlListMappingResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -24963,10 +31824,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthCallsIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json": { @@ -24981,9 +31839,9 @@ "sid", "friendly_name" ], - "pathType": "instance", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json", - "className": "auth_calls_ip_access_control_list_mapping" + "className": "auth_calls_ip_access_control_list_mapping", + "pathType": "instance" }, "get": { "description": "Fetch a specific instance of an IP Access Control List mapping", @@ -25031,6 +31889,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -25042,10 +31911,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthCallsIpAccessControlListMapping" }, "delete": { "description": "Delete an IP Access Control List mapping from the requested domain", @@ -25097,10 +31963,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthCallsIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json": { @@ -25109,12 +31972,12 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json", - "className": "auth_type_registrations" + "className": "auth_type_registrations", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json": { @@ -25129,9 +31992,9 @@ "sid", "friendly_name" ], - "pathType": "list", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json", - "className": "auth_registrations_credential_list_mapping" + "className": "auth_registrations_credential_list_mapping", + "pathType": "list" }, "post": { "description": "Create a new credential list mapping resource", @@ -25167,6 +32030,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -25179,9 +32053,6 @@ } ], "operationId": "CreateSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25200,6 +32071,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -25265,44 +32143,89 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipAuthRegistrationsCredentialListMappingResponse", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipAuthRegistrationsCredentialListMappingResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readEmpty": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 + } + }, + "readFull": { + "value": { + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "end": 0, + "previous_page_uri": null, + "contents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0", + "page_size": 50, + "start": 0, + "next_page_uri": null, + "page": 0 } } } @@ -25316,10 +32239,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthRegistrationsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json": { @@ -25334,9 +32254,9 @@ "sid", "friendly_name" ], - "pathType": "instance", "parent": "/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json", - "className": "auth_registrations_credential_list_mapping" + "className": "auth_registrations_credential_list_mapping", + "pathType": "instance" }, "get": { "description": "Fetch a specific instance of a credential list mapping", @@ -25384,6 +32304,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Thu, 30 Jul 2015 20:00:00 +0000", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -25395,10 +32326,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthRegistrationsCredentialListMapping" }, "delete": { "description": "Delete a credential list mapping from the requested domain", @@ -25450,10 +32378,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthRegistrationsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json": { @@ -25469,8 +32394,8 @@ "username", "credential_list_sid" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of credentials.", @@ -25532,44 +32457,91 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipCredentialResponse", - "properties": { - "credentials": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipCredentialResponse", + "properties": { + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "1440013725.28" + } + ], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "credentials": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0" } } } @@ -25583,10 +32555,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredential" }, "post": { "description": "Create a new credential resource.", @@ -25622,6 +32591,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "1440013725.28" + } + } } } }, @@ -25634,9 +32616,6 @@ } ], "operationId": "CreateSipCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25657,6 +32636,14 @@ "Username", "Password" ] + }, + "examples": { + "create": { + "value": { + "Password": "password", + "Username": "username" + } + } } } } @@ -25676,8 +32663,8 @@ "username", "credential_list_sid" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch a single credential.", @@ -25725,6 +32712,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "1440013725.28" + } + } } } }, @@ -25736,10 +32736,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredential" }, "post": { "description": "Update a credential resource.", @@ -25787,6 +32784,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 19 Aug 2015 19:48:45 +0000", + "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000", + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "username": "username" + } + } } } }, @@ -25799,9 +32809,6 @@ } ], "operationId": "UpdateSipCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25814,6 +32821,13 @@ "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)" } } + }, + "examples": { + "update": { + "value": { + "Password": "password" + } + } } } } @@ -25869,10 +32883,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredential" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json": { @@ -25887,11 +32898,11 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "credential": "{account_sid: account_sid, credential_list_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "list" }, "get": { "description": "Get All Credential Lists", @@ -25941,44 +32952,93 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipCredentialListResponse", - "properties": { - "credential_lists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipCredentialListResponse", + "properties": { + "credential_lists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "credential_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "credential_lists": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0" } } } @@ -25992,10 +33052,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredentialList" }, "post": { "description": "Create a Credential List", @@ -26019,6 +33076,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26031,9 +33103,6 @@ } ], "operationId": "CreateSipCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26049,6 +33118,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -26067,11 +33143,11 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "credential": "{account_sid: account_sid, credential_list_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "instance" }, "get": { "description": "Get a Credential List", @@ -26107,6 +33183,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26118,10 +33209,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredentialList" }, "post": { "description": "Update a Credential List", @@ -26157,6 +33245,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Low Rises", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26169,9 +33272,6 @@ } ], "operationId": "UpdateSipCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26187,6 +33287,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -26230,10 +33337,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredentialList" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json": { @@ -26248,8 +33352,8 @@ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a CredentialListMapping resource for an account.", @@ -26285,6 +33389,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Production Gateways IP Address - Scranton", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26297,9 +33414,6 @@ } ], "operationId": "CreateSipCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26318,6 +33432,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -26383,44 +33504,91 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipCredentialListMappingResponse", - "properties": { - "credential_list_mappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipCredentialListMappingResponse", + "properties": { + "credential_list_mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "credential_list_mappings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Production Gateways IP Address - Scranton", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "credential_list_mappings": [], + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0", + "next_page_uri": null, + "start": 0, + "end": 0, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0" } } } @@ -26434,10 +33602,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json": { @@ -26452,8 +33617,8 @@ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch a single CredentialListMapping resource from an account.", @@ -26501,6 +33666,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 11 Sep 2013 17:51:38 +0000", + "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000", + "friendly_name": "Production Gateways IP Address - Scranton", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -26512,10 +33690,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredentialListMapping" }, "delete": { "description": "Delete a CredentialListMapping resource from an account.", @@ -26567,10 +33742,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json": { @@ -26586,13 +33758,13 @@ "domain_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "ip_access_control_list_mapping": "{account_sid: account_sid, domain_sid: sid}", "credential_list_mapping": "{account_sid: account_sid, domain_sid: sid}", "auth_types": "{account_sid: account_sid, domain_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of domains belonging to the account used to make the request", @@ -26642,44 +33814,108 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipDomainResponse", - "properties": { - "domains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipDomainResponse", + "properties": { + "domains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "domains": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "domains": [], + "start": 0, + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0" } } } @@ -26693,10 +33929,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipDomain" }, "post": { "description": "Create a new Domain", @@ -26720,6 +33953,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -26732,9 +33995,6 @@ } ], "operationId": "CreateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26834,6 +34094,25 @@ "required": [ "DomainName" ] + }, + "examples": { + "create": { + "value": { + "DomainName": "dunder-mifflin-scranton.sip.twilio.com", + "FriendlyName": "Scranton Office", + "VoiceFallbackMethod": "POST", + "VoiceFallbackUrl": "", + "VoiceMethod": "POST", + "VoiceStatusCallbackMethod": "POST", + "VoiceStatusCallbackUrl": "", + "VoiceUrl": "https://dundermifflin.example.com/twilio/app.php", + "SipRegistration": true, + "EmergencyCallingEnabled": true, + "Secure": true, + "ByocTrunkSid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EmergencyCallerSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -26853,13 +34132,13 @@ "domain_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "ip_access_control_list_mapping": "{account_sid: account_sid, domain_sid: sid}", "credential_list_mapping": "{account_sid: account_sid, domain_sid: sid}", "auth_types": "{account_sid: account_sid, domain_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a Domain", @@ -26895,6 +34174,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -26906,10 +34215,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipDomain" }, "post": { "description": "Update the attributes of a domain", @@ -26945,6 +34251,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "auth_type": "IP_ACL", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "domain_name": "dunder-mifflin-scranton.sip.twilio.com", + "friendly_name": "Scranton Office", + "sip_registration": true, + "sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "credential_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json", + "ip_access_control_list_mappings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "voice_fallback_method": "POST", + "voice_fallback_url": null, + "voice_method": "POST", + "voice_status_callback_method": "POST", + "voice_status_callback_url": null, + "voice_url": "https://dundermifflin.example.com/twilio/app.php", + "emergency_calling_enabled": true, + "secure": true, + "byoc_trunk_sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "emergency_caller_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -26957,9 +34293,6 @@ } ], "operationId": "UpdateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27056,6 +34389,25 @@ "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call." } } + }, + "examples": { + "update": { + "value": { + "DomainName": "dunder-mifflin-scranton.sip.twilio.com", + "FriendlyName": "Scranton Office", + "VoiceFallbackMethod": "POST", + "VoiceFallbackUrl": "", + "VoiceMethod": "POST", + "VoiceStatusCallbackMethod": "POST", + "VoiceStatusCallbackUrl": "", + "VoiceUrl": "https://dundermifflin.example.com/twilio/app.php", + "SipRegistration": true, + "EmergencyCallingEnabled": true, + "Secure": true, + "ByocTrunkSid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EmergencyCallerSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -27099,10 +34451,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipDomain" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json": { @@ -27117,11 +34466,11 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "ip_address": "{account_sid: account_sid, ip_access_control_list_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of IpAccessControlLists that belong to the account used to make the request", @@ -27171,44 +34520,93 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipIpAccessControlListResponse", - "properties": { - "ip_access_control_lists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipIpAccessControlListResponse", + "properties": { + "ip_access_control_lists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0", + "ip_access_control_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0", + "ip_access_control_lists": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0" } } } @@ -27222,10 +34620,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAccessControlList" }, "post": { "description": "Create a new IpAccessControlList resource", @@ -27249,6 +34644,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27261,9 +34671,6 @@ } ], "operationId": "CreateSipIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27279,6 +34686,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -27297,11 +34711,11 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "ip_address": "{account_sid: account_sid, ip_access_control_list_sid: sid}" }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "instance" }, "get": { "description": "Fetch a specific instance of an IpAccessControlList", @@ -27337,6 +34751,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27348,10 +34777,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAccessControlList" }, "post": { "description": "Rename an IpAccessControlList", @@ -27387,6 +34813,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subresource_uris": { + "ip_addresses": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27399,9 +34840,6 @@ } ], "operationId": "UpdateSipIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27417,6 +34855,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -27460,10 +34905,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAccessControlList" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json": { @@ -27478,8 +34920,8 @@ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an IpAccessControlListMapping resource.", @@ -27527,6 +34969,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27538,10 +34993,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAccessControlListMapping" }, "delete": { "description": "Delete an IpAccessControlListMapping resource.", @@ -27593,10 +35045,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json": { @@ -27611,8 +35060,8 @@ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/Domains/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new IpAccessControlListMapping resource.", @@ -27648,6 +35097,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27660,9 +35122,6 @@ } ], "operationId": "CreateSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27681,6 +35140,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -27746,44 +35212,91 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipIpAccessControlListMappingResponse", - "properties": { - "ip_access_control_list_mappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipIpAccessControlListMappingResponse", + "properties": { + "ip_access_control_list_mappings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0", + "ip_access_control_list_mappings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Fri, 17 Jul 2015 21:25:15 +0000", + "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000", + "friendly_name": "aaaa", + "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0", + "ip_access_control_list_mappings": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0" } } } @@ -27797,10 +35310,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json": { @@ -27816,8 +35326,8 @@ "ip_address", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json", + "pathType": "list" }, "get": { "description": "Read multiple IpAddress resources.", @@ -27879,44 +35389,93 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSipIpAddressResponse", - "properties": { - "ip_addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListSipIpAddressResponse", + "properties": { + "ip_addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0", + "ip_addresses": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0", + "ip_addresses": [], + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0" } } } @@ -27930,10 +35489,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAddress" }, "post": { "description": "Create a new IpAddress resource.", @@ -27969,6 +35525,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -27981,9 +35552,6 @@ } ], "operationId": "CreateSipIpAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28008,6 +35576,15 @@ "FriendlyName", "IpAddress" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "192.168.1.1", + "CidrPrefixLength": 32 + } + } } } } @@ -28027,8 +35604,8 @@ "ip_address", "friendly_name" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json" + "parent": "/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Read one IpAddress resource.", @@ -28076,6 +35653,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -28087,10 +35679,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAddress" }, "post": { "description": "Update an IpAddress resource.", @@ -28138,6 +35727,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Mon, 20 Jul 2015 17:27:10 +0000", + "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000", + "friendly_name": "friendly_name", + "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1", + "cidr_prefix_length": 32, + "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -28150,9 +35754,6 @@ } ], "operationId": "UpdateSipIpAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28173,6 +35774,15 @@ "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "192.168.1.1", + "CidrPrefixLength": 32 + } + } } } } @@ -28228,10 +35838,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAddress" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json": { @@ -28246,8 +35853,8 @@ "call_sid", "name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a Siprec", @@ -28283,6 +35890,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.siprec" + }, + "examples": { + "createNoArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myName", + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -28295,9 +35926,6 @@ } ], "operationId": "CreateSiprec", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29129,6 +36757,26 @@ "description": "Parameter value" } } + }, + "examples": { + "createNoArgs": { + "value": {} + }, + "createWithArgs": { + "value": { + "Name": "myName", + "ConnectorName": "myConnectorName", + "Track": "inbound_track", + "StatusCallback": "http://statuscallback.com", + "StatusCallbackMethod": "PUT", + "Parameter1.Name": "name1", + "Parameter1.Value": "value1", + "Parameter2.Name": "name2", + "Parameter2.Value": "value2", + "Parameter3.Name": "name3", + "Parameter3.Value": "value3" + } + } } } } @@ -29147,8 +36795,8 @@ "call_sid", "name" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "post": { "description": "Stop a Siprec using either the SID of the Siprec resource or the `name` used when creating the resource", @@ -29193,6 +36841,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.siprec" + }, + "examples": { + "updateBySid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "updateByName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "mySiprec", + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -29205,9 +36877,6 @@ } ], "operationId": "UpdateSiprec", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29224,6 +36893,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } } } } @@ -29242,8 +36923,8 @@ "call_sid", "name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a Stream", @@ -29279,6 +36960,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.stream" + }, + "examples": { + "createNoArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "createWithArgs": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myName", + "status": "in-progress", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -29291,9 +36996,6 @@ } ], "operationId": "CreateStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30129,6 +37831,28 @@ "required": [ "Url" ] + }, + "examples": { + "createNoArgs": { + "value": { + "Url": "myUrl" + } + }, + "createWithArgs": { + "value": { + "Name": "myName", + "Url": "myUrl", + "Track": "inbound_track", + "StatusCallback": "http://statuscallback.com", + "StatusCallbackMethod": "PUT", + "Parameter1.Name": "name1", + "Parameter1.Value": "value1", + "Parameter2.Name": "name2", + "Parameter2.Value": "value2", + "Parameter3.Name": "name3", + "Parameter3.Value": "value3" + } + } } } } @@ -30147,8 +37871,8 @@ "call_sid", "name" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "post": { "description": "Stop a Stream using either the SID of the Stream resource or the `name` used when creating the resource", @@ -30193,6 +37917,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.stream" + }, + "examples": { + "updateBySid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": null, + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + }, + "updateByName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "myStream", + "status": "stopped", + "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -30205,9 +37953,6 @@ } ], "operationId": "UpdateStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30224,6 +37969,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } } } } @@ -30242,8 +37999,8 @@ "username", "ice_servers" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new token for ICE servers", @@ -30267,6 +38024,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.token" + }, + "examples": { + "create": { + "value": { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "ice_servers": [ + { + "urls": "stun:global.stun.twilio.com:3478" + }, + { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "credential": "tE2DajzSJwnsSbc123", + "urls": "turn:global.turn.twilio.com:3478?transport=udp" + }, + { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "credential": "tE2DajzSJwnsSbc123", + "urls": "turn:global.turn.twilio.com:3478?transport=tcp" + }, + { + "username": "dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269", + "credential": "tE2DajzSJwnsSbc123", + "urls": "turn:global.turn.twilio.com:443?transport=tcp" + } + ], + "date_updated": "Fri, 01 May 2020 01:42:57 +0000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ttl": "86400", + "date_created": "Fri, 01 May 2020 01:42:57 +0000", + "password": "tE2DajzSJwnsSbc123" + } + } } } }, @@ -30279,9 +38068,6 @@ } ], "operationId": "CreateToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30294,6 +38080,13 @@ "description": "The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours)." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 1 + } + } } } } @@ -30314,8 +38107,8 @@ "status", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a Transcription", @@ -30351,6 +38144,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.transcription" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Sun, 13 Feb 2011 02:12:08 +0000", + "date_updated": "Sun, 13 Feb 2011 02:30:01 +0000", + "duration": "1", + "price": "-0.05000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "transcription_text": "(blank)", + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -30362,10 +38174,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTranscription" }, "delete": { "description": "Delete a transcription from the account used to make the request", @@ -30405,10 +38214,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Transcriptions.json": { @@ -30425,8 +38231,8 @@ "status", "duration" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of transcriptions belonging to the account used to make the request", @@ -30475,45 +38281,104 @@ "200": { "content": { "application/json": { - "schema": { - "type": "object", - "title": "ListTranscriptionResponse", - "properties": { - "transcriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.transcription" - } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + "schema": { + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListTranscriptionResponse", + "properties": { + "transcriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.transcription" + } + } + } + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3", + "next_page_uri": null, + "num_pages": 4, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 4, + "transcriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2008-08-01", + "date_created": "Thu, 25 Aug 2011 20:59:45 +0000", + "date_updated": "Thu, 25 Aug 2011 20:59:45 +0000", + "duration": "10", + "price": "0.00000", + "price_unit": "USD", + "recording_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "transcription_text": null, + "type": "fast", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0" + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3", + "next_page_uri": null, + "num_pages": 4, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 4, + "transcriptions": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0" } } } @@ -30527,10 +38392,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Usage.json": { @@ -30539,11 +38401,11 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records.json": { @@ -30561,8 +38423,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage.json" + "parent": "/Accounts/{AccountSid}/Usage.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of usage-records belonging to the account used to make the request", @@ -30586,6 +38448,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_category" + }, + "examples": { + "readFull": { + "value": "calleridlookups" + }, + "readEmpty": { + "value": "calleridlookups" + } } }, { @@ -30595,6 +38465,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -30604,6 +38482,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -30647,44 +38533,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "totalprice", + "count": null, + "count_unit": "", + "description": "Total Price", + "end_date": "2015-09-04", + "price": "2192.84855", + "price_unit": "usd", + "start_date": "2011-08-23", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=totalprice", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=totalprice", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=totalprice", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=totalprice", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=totalprice", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=totalprice", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=totalprice", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=totalprice" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice&StartDate=2011-08-23&EndDate=2015-09-04", + "usage": "2192.84855", + "usage_unit": "usd" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records", + "usage_records": [] } } } @@ -30698,10 +38654,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecord" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json": { @@ -30719,8 +38672,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -30805,44 +38758,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordAllTimeResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordAllTimeResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2011-08-23", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Category=sms-inbound-shortcode&StartDate=2011-08-23&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime", + "usage_records": [] } } } @@ -30856,10 +38879,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordAllTime", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordAllTime" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json": { @@ -30877,8 +38897,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -30963,44 +38983,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordDailyResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordDailyResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1", + "next_page_uri": null, + "num_pages": 101844, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 101844, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-06", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-06", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Category=sms-inbound-shortcode&StartDate=2015-09-06&EndDate=2015-09-06", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1", + "next_page_uri": null, + "num_pages": 101844, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 101844, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily", + "usage_records": [] } } } @@ -31014,10 +39104,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordDaily", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordDaily" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json": { @@ -31035,8 +39122,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -31121,44 +39208,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordLastMonthResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordLastMonthResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-08-31", + "price": "0", + "price_unit": "usd", + "start_date": "2015-08-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Category=sms-inbound-shortcode&StartDate=2015-08-01&EndDate=2015-08-31", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth", + "usage_records": [] } } } @@ -31172,10 +39329,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordLastMonth", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordLastMonth" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json": { @@ -31193,8 +39347,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -31279,44 +39433,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordMonthlyResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordMonthlyResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1", + "next_page_uri": null, + "num_pages": 3450, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 3450, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1", + "next_page_uri": null, + "num_pages": 3450, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 3450, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly", + "usage_records": [] } } } @@ -31330,10 +39554,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordMonthly", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordMonthly" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json": { @@ -31351,8 +39572,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -31437,44 +39658,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordThisMonthResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordThisMonthResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth", + "usage_records": [] } } } @@ -31488,10 +39779,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordThisMonth", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordThisMonth" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json": { @@ -31509,8 +39797,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -31595,44 +39883,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordTodayResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordTodayResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-04", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Category=sms-inbound-shortcode&StartDate=2015-09-04&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today", + "usage_records": [] } } } @@ -31646,10 +40004,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordToday", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordToday" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json": { @@ -31667,8 +40022,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -31753,44 +40108,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordYearlyResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordYearlyResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1", + "next_page_uri": null, + "num_pages": 345, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 345, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-04", + "price": "0", + "price_unit": "usd", + "start_date": "2015-01-01", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Category=sms-inbound-shortcode&StartDate=2015-01-01&EndDate=2015-09-04", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1", + "next_page_uri": null, + "num_pages": 345, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 345, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly", + "usage_records": [] } } } @@ -31804,10 +40229,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordYearly", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordYearly" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json": { @@ -31825,8 +40247,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -31911,44 +40333,114 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageRecordYesterdayResponse", - "properties": { - "usage_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageRecordYesterdayResponse", + "properties": { + "usage_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday", + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "as_of": "2019-06-24T22:32:49+00:00", + "category": "sms-inbound-shortcode", + "count": "0", + "count_unit": "messages", + "description": "Short Code Inbound SMS", + "end_date": "2015-09-03", + "price": "0", + "price_unit": "usd", + "start_date": "2015-09-03", + "subresource_uris": { + "all_time": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode", + "daily": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode", + "last_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode", + "monthly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode", + "this_month": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode", + "today": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode", + "yearly": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode", + "yesterday": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode" + }, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Category=sms-inbound-shortcode&StartDate=2015-09-03&EndDate=2015-09-03", + "usage": "0", + "usage_unit": "messages" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1", + "next_page_uri": null, + "num_pages": 69, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 69, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday", + "usage_records": [] } } } @@ -31962,10 +40454,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordYesterday", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordYesterday" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json": { @@ -31982,8 +40471,8 @@ "usage_category", "trigger_by" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Usage.json" + "parent": "/Accounts/{AccountSid}/Usage.json", + "pathType": "instance" }, "get": { "description": "Fetch and instance of a usage-trigger", @@ -32019,6 +40508,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + } } } }, @@ -32030,10 +40541,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUsageTrigger" }, "post": { "description": "Update an instance of a usage trigger", @@ -32069,6 +40577,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + } } } }, @@ -32081,9 +40611,6 @@ } ], "operationId": "UpdateUsageTrigger", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32114,6 +40641,15 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "CallbackMethod": "GET", + "CallbackUrl": "https://example.com", + "FriendlyName": "friendly_name" + } + } } } } @@ -32157,10 +40693,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUsageTrigger" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json": { @@ -32177,8 +40710,8 @@ "usage_category", "trigger_by" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage.json" + "parent": "/Accounts/{AccountSid}/Usage.json", + "pathType": "list" }, "post": { "description": "Create a new UsageTrigger", @@ -32202,6 +40735,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + } } } }, @@ -32214,9 +40769,6 @@ } ], "operationId": "CreateUsageTrigger", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32271,6 +40823,19 @@ "TriggerValue", "UsageCategory" ] + }, + "examples": { + "create": { + "value": { + "CallbackMethod": "GET", + "CallbackUrl": "https://example.com", + "FriendlyName": "friendly_name", + "Recurring": "daily", + "TriggerBy": "count", + "TriggerValue": "trigger_value", + "UsageCategory": "calleridlookups" + } + } } } } @@ -32298,6 +40863,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_recurring" + }, + "examples": { + "readFull": { + "value": "daily" + }, + "readEmpty": { + "value": "daily" + } } }, { @@ -32307,6 +40880,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_trigger_field" + }, + "examples": { + "readFull": { + "value": "count" + }, + "readEmpty": { + "value": "count" + } } }, { @@ -32316,6 +40897,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_usage_category" + }, + "examples": { + "readFull": { + "value": "calleridlookups" + }, + "readEmpty": { + "value": "calleridlookups" + } } }, { @@ -32351,44 +40940,106 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListUsageTriggerResponse", - "properties": { - "usage_triggers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + "allOf": [ + { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + { + "type": "object", + "title": "ListUsageTriggerResponse", + "properties": { + "usage_triggers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + } + } } - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "type": "string", - "format": "uri" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true - }, - "start": { - "type": "integer" - }, - "uri": { - "type": "string", - "format": "uri" + } + ] + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626", + "next_page_uri": null, + "num_pages": 627, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 627, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers", + "usage_triggers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "callback_method": "GET", + "callback_url": "http://cap.com/streetfight", + "current_value": "0", + "date_created": "Sun, 06 Sep 2015 12:58:45 +0000", + "date_fired": null, + "date_updated": "Sun, 06 Sep 2015 12:58:45 +0000", + "friendly_name": "raphael-cluster-1441544325.86", + "recurring": "yearly", + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trigger_by": "price", + "trigger_value": "50", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_category": "totalprice", + "usage_record_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice" + } + ] + } + }, + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0", + "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626", + "next_page_uri": null, + "num_pages": 627, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "start": 0, + "total": 627, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers", + "usage_triggers": [] } } } @@ -32402,10 +41053,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageTrigger" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json": { @@ -32419,8 +41067,8 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create a new User Defined Message for the given Call SID.", @@ -32456,6 +41104,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.user_defined_message" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "KXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000" + } + } } } }, @@ -32468,9 +41126,6 @@ } ], "operationId": "CreateUserDefinedMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32490,6 +41145,14 @@ "required": [ "Content" ] + }, + "examples": { + "create": { + "value": { + "Content": "{\"key\":\"value\"}", + "IdempotencyKey": "1" + } + } } } } @@ -32507,8 +41170,8 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "post": { "description": "Subscribe to User Defined Messages for a given Call SID.", @@ -32544,6 +41207,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.call.user_defined_message_subscription" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 18 Dec 2019 20:02:01 +0000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions/ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } } } }, @@ -32556,9 +41230,6 @@ } ], "operationId": "CreateUserDefinedMessageSubscription", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -32592,6 +41263,15 @@ "required": [ "Callback" ] + }, + "examples": { + "create": { + "value": { + "Callback": "http://www.example.com", + "Method": "POST", + "IdempotencyKey": "1" + } + } } } } @@ -32609,8 +41289,8 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Delete a specific User Defined Message Subscription.", @@ -32662,10 +41342,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserDefinedMessageSubscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserDefinedMessageSubscription" } } }, @@ -32673,19 +41350,5 @@ { "url": "https://api.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - }, - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json index 902ad0cc..1a370a55 100644 --- a/spec/json/twilio_autopilot_v1.json +++ b/spec/json/twilio_autopilot_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "autopilot.v1.assistant": { "type": "object", @@ -933,12 +939,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -954,7 +954,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -964,14 +964,13 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "field_type": "{assistant_sid: sid}", "task": "{assistant_sid: sid}", @@ -981,7 +980,8 @@ "defaults": "{assistant_sid: sid}", "dialogue": "{assistant_sid: sid}", "webhook": "{assistant_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1002,6 +1002,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "development_stage": "in-development", + "needs_model_build": false, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", + "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", + "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } } } }, @@ -1013,10 +1042,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAssistant" }, "post": { "description": "", @@ -1037,6 +1063,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "development_stage": "in-development", + "needs_model_build": false, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", + "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", + "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } } } }, @@ -1049,9 +1104,6 @@ } ], "operationId": "UpdateAssistant", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1091,6 +1143,20 @@ "description": "A string describing the state of the assistant." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "so so friendly", + "UniqueName": "so-so-unique", + "LogQueries": true, + "DevelopmentStage": "in-development", + "CallbackUrl": "https://example.com/callback_url", + "CallbackEvents": "model_build_completed model_build_failed", + "StyleSheet": "{}", + "Defaults": "{}" + } + } } } } @@ -1119,10 +1185,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAssistant" } }, "/v1/Assistants": { @@ -1131,14 +1194,13 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "field_type": "{assistant_sid: sid}", "task": "{assistant_sid: sid}", @@ -1148,7 +1210,8 @@ "defaults": "{assistant_sid: sid}", "dialogue": "{assistant_sid: sid}", "webhook": "{assistant_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "", @@ -1196,16 +1259,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1214,17 +1279,71 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "assistants": [], + "meta": { + "first_page_url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0", + "key": "assistants", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "assistants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "development_stage": "in-development", + "needs_model_build": false, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", + "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", + "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + ], + "meta": { + "first_page_url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0", + "key": "assistants", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0" } } } @@ -1239,10 +1358,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAssistant" }, "post": { "description": "", @@ -1252,6 +1368,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "development_stage": "in-development", + "needs_model_build": false, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", + "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", + "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } } } }, @@ -1264,9 +1409,6 @@ } ], "operationId": "CreateAssistant", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1302,6 +1444,19 @@ "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "so so friendly", + "UniqueName": "so-so-unique", + "LogQueries": true, + "CallbackUrl": "https://example.com/callback_url", + "CallbackEvents": "model_build_completed model_build_failed", + "StyleSheet": "{}", + "Defaults": "{}" + } + } } } } @@ -1314,14 +1469,14 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "data" ], - "pathType": "instance", "parent": "/Assistants/{Sid}", - "className": "defaults" + "className": "defaults", + "pathType": "instance" }, "get": { "description": "", @@ -1342,6 +1497,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {}, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults" + } + } } } }, @@ -1353,10 +1518,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDefaults", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDefaults" }, "post": { "description": "", @@ -1377,6 +1539,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", + "data": {} + } + } } } }, @@ -1389,9 +1561,6 @@ } ], "operationId": "UpdateDefaults", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1403,6 +1572,13 @@ "description": "A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations." } } + }, + "examples": { + "update": { + "value": { + "Defaults": "{}" + } + } } } } @@ -1415,14 +1591,14 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "data" ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1452,6 +1628,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.dialogue" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {} + } + } } } }, @@ -1463,10 +1650,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialogue", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialogue" } }, "/v1/Assistants/{AssistantSid}/Dialogues": { @@ -1475,14 +1659,14 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "data" ], - "pathType": "list", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" } }, "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { @@ -1491,15 +1675,15 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "field_type" ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1538,6 +1722,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" + }, + "examples": { + "fetch": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type": "field_type" + } + } } } }, @@ -1549,10 +1748,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchField", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchField" }, "delete": { "description": "", @@ -1595,10 +1791,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteField", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteField" } }, "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { @@ -1607,15 +1800,15 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "field_type" ], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1681,16 +1874,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1699,17 +1894,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "fields": [], + "meta": { + "page": 0, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "key": "fields", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + } + } + }, + "readFull": { + "value": { + "fields": [ + { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type": "field_type" + } + ], + "meta": { + "page": 0, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "key": "fields", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 } } } @@ -1724,10 +1959,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListField", - "x-maturity": [ - "Preview" - ] + "operationId": "ListField" }, "post": { "description": "", @@ -1757,6 +1989,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" + }, + "examples": { + "create": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type": "field_type" + } + } } } }, @@ -1769,9 +2016,6 @@ } ], "operationId": "CreateField", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1792,6 +2036,14 @@ "FieldType", "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "FieldType": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1804,18 +2056,18 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" }, - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1845,6 +2097,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + }, + "examples": { + "fetch": { + "value": { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1856,10 +2125,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFieldType", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchFieldType" }, "post": { "description": "", @@ -1889,6 +2155,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + }, + "examples": { + "update": { + "value": { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1901,9 +2184,6 @@ } ], "operationId": "UpdateFieldType", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1920,6 +2200,14 @@ "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" + } + } } } } @@ -1957,10 +2245,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFieldType", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteFieldType" } }, "/v1/Assistants/{AssistantSid}/FieldTypes": { @@ -1969,18 +2254,18 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" }, - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2037,16 +2322,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2055,18 +2342,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "previous_page_url": null, + "page": 0, + "page_size": 50, + "next_page_url": null, + "key": "field_types" + }, + "field_types": [] + } + }, + "readFull": { + "value": { + "meta": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "previous_page_url": null, + "page": 0, + "page_size": 50, + "next_page_url": null, + "key": "field_types" + }, + "field_types": [ + { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2080,10 +2409,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFieldType", - "x-maturity": [ - "Preview" - ] + "operationId": "ListFieldType" }, "post": { "description": "", @@ -2104,6 +2430,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + }, + "examples": { + "create": { + "value": { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2116,9 +2459,6 @@ } ], "operationId": "CreateFieldType", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2138,6 +2478,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" + } + } } } } @@ -2150,15 +2498,15 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "value", "language" ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2197,6 +2545,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "language": "language", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": "value", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "synonym_of": null + } + } } } }, @@ -2208,10 +2572,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchFieldValue" }, "delete": { "description": "", @@ -2254,10 +2615,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteFieldValue" } }, "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { @@ -2266,15 +2624,15 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "value", "language" ], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2303,6 +2661,14 @@ "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "language" + }, + "readFull": { + "value": "language" + } } }, { @@ -2348,16 +2714,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2366,17 +2734,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "field_values": [], + "meta": { + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", + "page_size": 50, + "previous_page_url": null, + "key": "field_values", + "page": 0, + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "field_values": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "language": "language", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": "value", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + ], + "meta": { + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", + "page_size": 50, + "previous_page_url": null, + "key": "field_values", + "page": 0, + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" } } } @@ -2391,10 +2800,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "ListFieldValue" }, "post": { "description": "", @@ -2424,6 +2830,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "language": "language", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": "value", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } }, @@ -2436,9 +2858,6 @@ } ], "operationId": "CreateFieldValue", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2463,6 +2882,15 @@ "Language", "Value" ] + }, + "examples": { + "create": { + "value": { + "Value": "value", + "Language": "language", + "SynonymOf": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } @@ -2475,7 +2903,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2483,8 +2911,8 @@ "status", "date_created" ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2514,6 +2942,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "enqueued", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": null, + "error_code": null + } + } } } }, @@ -2525,10 +2969,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchModelBuild" }, "post": { "description": "", @@ -2558,6 +2999,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": 100, + "error_code": null + } + } } } }, @@ -2570,9 +3027,6 @@ } ], "operationId": "UpdateModelBuild", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2585,6 +3039,13 @@ "description": "An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name" + } + } } } } @@ -2622,10 +3083,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteModelBuild" } }, "/v1/Assistants/{AssistantSid}/ModelBuilds": { @@ -2634,7 +3092,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2642,8 +3100,8 @@ "status", "date_created" ], - "pathType": "list", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2700,16 +3158,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2718,18 +3178,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "key": "model_builds", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + }, + "model_builds": [] + } + }, + "readFull": { + "value": { + "meta": { + "page": 0, + "key": "model_builds", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + }, + "model_builds": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": null, + "error_code": 23001 + } + ] } } } @@ -2743,10 +3244,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "ListModelBuild" }, "post": { "description": "", @@ -2767,6 +3265,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "enqueued", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": null, + "error_code": null + } + } } } }, @@ -2779,9 +3293,6 @@ } ], "operationId": "CreateModelBuild", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2799,6 +3310,14 @@ "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -2811,7 +3330,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2819,8 +3338,8 @@ "status", "language" ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2850,6 +3369,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.query" + }, + "examples": { + "fetch": { + "value": { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": "name", + "fields": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": "voice", + "dialogue_sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2861,10 +3409,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchQuery" }, "post": { "description": "", @@ -2894,6 +3439,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.query" + }, + "examples": { + "update": { + "value": { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": "name", + "fields": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": "sms", + "dialogue_sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2906,9 +3480,6 @@ } ], "operationId": "UpdateQuery", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2928,6 +3499,14 @@ "description": "The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded`" } } + }, + "examples": { + "update": { + "value": { + "Status": "status", + "SampleSid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2965,10 +3544,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteQuery" } }, "/v1/Assistants/{AssistantSid}/Queries": { @@ -2977,7 +3553,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2985,8 +3561,8 @@ "status", "language" ], - "pathType": "list", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3006,6 +3582,14 @@ "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "language" + }, + "readFull": { + "value": "language" + } } }, { @@ -3014,6 +3598,14 @@ "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3022,6 +3614,14 @@ "description": "The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } } }, { @@ -3033,6 +3633,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^UK[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3078,16 +3686,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3096,17 +3706,71 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "queries": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page": 0, + "key": "queries", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page_size": 50 + } + } + }, + "readFull": { + "value": { + "queries": [ + { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": "name", + "fields": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": null, + "dialogue_sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page": 0, + "key": "queries", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page_size": 50 } } } @@ -3121,10 +3785,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "ListQuery" }, "post": { "description": "", @@ -3145,6 +3806,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.query" + }, + "examples": { + "create": { + "value": { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": "name", + "fields": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": "voice", + "dialogue_sid": null + } + } } } }, @@ -3157,9 +3847,6 @@ } ], "operationId": "CreateQuery", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3188,6 +3875,16 @@ "Language", "Query" ] + }, + "examples": { + "create": { + "value": { + "Language": "language", + "Query": "query", + "Tasks": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "ModelBuild": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3200,7 +3897,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3208,8 +3905,8 @@ "unique_name", "friendly_name" ], - "pathType": "list", - "mountName": "restore_assistant" + "mountName": "restore_assistant", + "pathType": "list" }, "post": { "description": "", @@ -3219,6 +3916,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.restore_assistant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "unique_name": "so-so-unique", + "friendly_name": "so so friendly", + "needs_model_build": false, + "latest_model_build_sid": null, + "log_queries": true, + "development_stage": "in-development", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } } } }, @@ -3231,9 +3946,6 @@ } ], "operationId": "UpdateRestoreAssistant", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3249,6 +3961,13 @@ "required": [ "Assistant" ] + }, + "examples": { + "update": { + "value": { + "Assistant": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3261,7 +3980,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3269,8 +3988,8 @@ "language", "source_channel" ], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3312,6 +4031,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + }, + "examples": { + "fetch": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": null + } + } } } }, @@ -3323,10 +4058,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSample", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSample" }, "post": { "description": "", @@ -3368,6 +4100,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + }, + "examples": { + "update": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": "alexa" + } + } } } }, @@ -3380,9 +4128,6 @@ } ], "operationId": "UpdateSample", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3403,6 +4148,14 @@ "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." } } + }, + "examples": { + "update": { + "value": { + "Language": "language", + "TaggedText": "tagged_text" + } + } } } } @@ -3452,10 +4205,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSample", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSample" } }, "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { @@ -3464,7 +4214,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3472,8 +4222,8 @@ "language", "source_channel" ], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3502,6 +4252,14 @@ "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "language" + }, + "readFull": { + "value": "language" + } } }, { @@ -3547,16 +4305,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3565,17 +4325,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "samples": [], + "meta": { + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "previous_page_url": null, + "key": "samples", + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "page": 0, + "page_size": 50 + } + } + }, + "readFull": { + "value": { + "samples": [ + { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": "sms" + } + ], + "meta": { + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "previous_page_url": null, + "key": "samples", + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "page": 0, + "page_size": 50 } } } @@ -3590,10 +4391,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSample", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSample" }, "post": { "description": "", @@ -3623,6 +4421,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + }, + "examples": { + "create": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": "alexa" + } + } } } }, @@ -3635,9 +4449,6 @@ } ], "operationId": "CreateSample", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3662,6 +4473,15 @@ "Language", "TaggedText" ] + }, + "examples": { + "create": { + "value": { + "Language": "language", + "TaggedText": "tagged_text", + "SourceChannel": "alexa" + } + } } } } @@ -3674,13 +4494,13 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "data" ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "Returns Style sheet JSON object for the Assistant", @@ -3701,6 +4521,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {}, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" + } + } } } }, @@ -3712,10 +4542,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStyleSheet", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchStyleSheet" }, "post": { "description": "Updates the style sheet for an Assistant identified by `assistant_sid`.", @@ -3736,6 +4563,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", + "data": {} + } + } } } }, @@ -3748,9 +4585,6 @@ } ], "operationId": "UpdateStyleSheet", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3762,6 +4596,13 @@ "description": "The JSON string that describes the style sheet object." } } + }, + "examples": { + "update": { + "value": { + "StyleSheet": "{}" + } + } } } } @@ -3774,21 +4615,21 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "field": "{assistant_sid: assistant_sid, task_sid: sid}", "sample": "{assistant_sid: assistant_sid, task_sid: sid}", "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" }, - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3818,6 +4659,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task" + }, + "examples": { + "fetch": { + "value": { + "unique_name": "unique_name", + "links": { + "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + } } } }, @@ -3829,10 +4691,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTask", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchTask" }, "post": { "description": "", @@ -3862,6 +4721,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task" + }, + "examples": { + "update": { + "value": { + "unique_name": "unique_name", + "links": { + "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + } } } }, @@ -3874,9 +4754,6 @@ } ], "operationId": "UpdateTask", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3901,6 +4778,16 @@ "description": "The URL from which the Assistant can fetch actions." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Actions": "{}", + "ActionsUrl": "https://example.com/actions_url" + } + } } } } @@ -3938,10 +4825,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTask", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteTask" } }, "/v1/Assistants/{AssistantSid}/Tasks": { @@ -3950,21 +4834,21 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "field": "{assistant_sid: assistant_sid, task_sid: sid}", "sample": "{assistant_sid: assistant_sid, task_sid: sid}", "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" }, - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -4021,16 +4905,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4039,18 +4925,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "key": "tasks", + "page_size": 50, + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "previous_page_url": null + }, + "tasks": [] + } + }, + "readFull": { + "value": { + "meta": { + "key": "tasks", + "page_size": 50, + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "previous_page_url": null + }, + "tasks": [ + { + "unique_name": "unique_name", + "links": { + "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + ] } } } @@ -4064,10 +4996,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTask", - "x-maturity": [ - "Preview" - ] + "operationId": "ListTask" }, "post": { "description": "", @@ -4088,6 +5017,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task" + }, + "examples": { + "create": { + "value": { + "unique_name": "unique_name", + "links": { + "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + } } } }, @@ -4100,9 +5050,6 @@ } ], "operationId": "CreateTask", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4130,6 +5077,16 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Actions": "{}", + "ActionsUrl": "https://example.com/actions_url" + } + } } } } @@ -4142,15 +5099,15 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "data" ], - "pathType": "instance", "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", "mountName": "task_actions", - "className": "task_actions" + "className": "task_actions", + "pathType": "instance" }, "get": { "description": "Returns JSON actions for the Task.", @@ -4180,6 +5137,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDdddddddddddddddddddddddddddddddd", + "data": {}, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" + } + } } } }, @@ -4191,10 +5159,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskActions", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchTaskActions" }, "post": { "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", @@ -4224,6 +5189,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDdddddddddddddddddddddddddddddddd", + "data": {}, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" + } + } } } }, @@ -4236,9 +5212,6 @@ } ], "operationId": "UpdateTaskActions", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4250,6 +5223,13 @@ "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." } } + }, + "examples": { + "update": { + "value": { + "Actions": "{\"actions\":[{}]}" + } + } } } } @@ -4262,15 +5242,15 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "samples_count", "fields_count" ], - "pathType": "instance", "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "className": "task_statistics" + "className": "task_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -4300,6 +5280,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_statistics" + }, + "examples": { + "fetch": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "samples_count": 0, + "fields_count": 0 + } + } } } }, @@ -4311,10 +5303,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskStatistics", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchTaskStatistics" } }, "/v1/Assistants/{AssistantSid}/Webhooks/{Sid}": { @@ -4323,7 +5312,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4332,8 +5321,8 @@ "wehbook_url", "webhook_method" ], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4363,6 +5352,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + }, + "examples": { + "fetch": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "unique_name": "unique_name", + "events": "ondialogueend", + "webhook_url": "https://example.com/url", + "webhook_method": "POST" + } + } } } }, @@ -4374,10 +5379,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebhook", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWebhook" }, "post": { "description": "", @@ -4407,6 +5409,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + }, + "examples": { + "update": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "unique_name": "unique_name", + "events": "ondialogueend", + "webhook_url": "https://example.com/url", + "webhook_method": "POST" + } + } } } }, @@ -4419,9 +5437,6 @@ } ], "operationId": "UpdateWebhook", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4447,6 +5462,16 @@ "description": "The method to be used when calling the webhook's URL." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "Events": "ondialogueend", + "WebhookUrl": "https://example.com/url", + "WebhookMethod": "POST" + } + } } } } @@ -4484,10 +5509,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebhook", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteWebhook" } }, "/v1/Assistants/{AssistantSid}/Webhooks": { @@ -4496,7 +5518,7 @@ "url": "https://autopilot.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4505,8 +5527,8 @@ "wehbook_url", "webhook_method" ], - "pathType": "list", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -4563,16 +5585,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4581,18 +5605,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "key": "webhooks", + "page_size": 50, + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "previous_page_url": null + }, + "webhooks": [] + } + }, + "readFull": { + "value": { + "meta": { + "key": "webhooks", + "page_size": 50, + "next_page_url": null, + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "previous_page_url": null + }, + "webhooks": [ + { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "unique_name": "unique_name", + "events": "ondialogueend", + "webhook_url": "https://example.com/url", + "webhook_method": "POST" + } + ] } } } @@ -4606,10 +5671,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebhook", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWebhook" }, "post": { "description": "", @@ -4630,6 +5692,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + }, + "examples": { + "create": { + "value": { + "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "unique_name": "unique_name", + "events": "ondialogueend", + "webhook_url": "https://example.com/url", + "webhook_method": "POST" + } + } } } }, @@ -4642,9 +5720,6 @@ } ], "operationId": "CreateWebhook", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4675,6 +5750,16 @@ "Events", "WebhookUrl" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Events": "ondialogueend", + "WebhookUrl": "https://example.com/url", + "WebhookMethod": "POST" + } + } } } } @@ -4686,11 +5771,5 @@ { "url": "https://autopilot.twilio.com" } - ], - "x-maturity": [ - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index aa67f4c7..99c5cc90 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "bulkexports.v1.export.day": { "type": "object", @@ -250,12 +256,6 @@ "DeletedByUserRequest" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -271,7 +271,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -281,7 +281,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "friendly_name", @@ -291,8 +291,8 @@ "size", "redirectTo" ], - "pathType": "instance", - "parent": "/Exports/{ResourceType}" + "parent": "/Exports/{ResourceType}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Day.", @@ -322,6 +322,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export.day-instance" + }, + "examples": { + "fetch": { + "value": { + "redirect_to": "https://documentation-example-twilio-bucket.s3.amazonaws.com/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -333,10 +340,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDay", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDay" } }, "/v1/Exports/{ResourceType}/Days": { @@ -345,7 +349,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "friendly_name", @@ -355,8 +359,8 @@ "size", "redirectTo" ], - "pathType": "list", - "parent": "/Exports/{ResourceType}" + "parent": "/Exports/{ResourceType}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Days for a resource.", @@ -413,16 +417,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -431,17 +437,53 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "days": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "next_page_url": null, + "key": "days" + } + } + }, + "readFull": { + "value": { + "days": [ + { + "day": "2017-04-01", + "size": 100, + "resource_type": "Messages", + "create_date": "2017-04-02", + "friendly_name": "friendly_name" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0", + "next_page_url": null, + "key": "days" } } } @@ -456,10 +498,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDay", - "x-maturity": [ - "GA" - ] + "operationId": "ListDay" } }, "/v1/Exports/{ResourceType}": { @@ -468,14 +507,14 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "day": "{resource_type: resource_type}", "export_custom_job": "{resource_type: resource_type}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Export.", @@ -496,6 +535,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export" + }, + "examples": { + "fetch": { + "value": { + "resource_type": "Messages", + "url": "https://bulkexports.twilio.com/v1/Exports/Messages", + "links": { + "days": "https://bulkexports.twilio.com/v1/Exports/Messages/Days" + } + } + } } } }, @@ -507,10 +557,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExport", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExport" } }, "/v1/Exports": { @@ -519,14 +566,14 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "day": "{resource_type: resource_type}", "export_custom_job": "{resource_type: resource_type}" - } + }, + "pathType": "list" } }, "/v1/Exports/{ResourceType}/Configuration": { @@ -535,7 +582,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "enabled", @@ -544,8 +591,8 @@ "webhook_method", "webhook_url" ], - "pathType": "instance", - "mountName": "export_configuration" + "mountName": "export_configuration", + "pathType": "instance" }, "get": { "description": "Fetch a specific Export Configuration.", @@ -566,6 +613,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export_configuration" + }, + "examples": { + "fetch": { + "value": { + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration", + "enabled": true, + "webhook_url": "", + "webhook_method": "", + "resource_type": "Messages" + } + } } } }, @@ -577,10 +635,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExportConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExportConfiguration" }, "post": { "description": "Update a specific Export Configuration.", @@ -601,6 +656,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export_configuration" + }, + "examples": { + "update": { + "value": { + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration", + "enabled": true, + "webhook_url": "", + "resource_type": "Messages", + "webhook_method": "" + } + } } } }, @@ -613,9 +679,6 @@ } ], "operationId": "UpdateExportConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -637,6 +700,13 @@ "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" } } + }, + "examples": { + "update": { + "value": { + "Enabled": true + } + } } } } @@ -649,7 +719,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -664,9 +734,9 @@ "webhook_method", "webhook_url" ], - "pathType": "list", "parent": "/Exports/{ResourceType}", - "mountName": "export_custom_jobs" + "mountName": "export_custom_jobs", + "pathType": "list" }, "get": { "description": "", @@ -723,16 +793,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -741,18 +813,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "page_size": 50, + "key": "jobs", + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "next_page_url": null, + "page": 0 + }, + "jobs": [] + } + }, + "readFull": { + "value": { + "meta": { + "previous_page_url": null, + "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "page_size": 50, + "key": "jobs", + "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0", + "next_page_url": null, + "page": 0 + }, + "jobs": [ + { + "start_day": "start_day", + "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "webhook_method": "webhook_method", + "details": {}, + "end_day": "end_day", + "webhook_url": "webhook_url", + "email": "email", + "resource_type": "resource_type", + "job_queue_position": "1", + "estimated_completion_time": "2021-03-15T20:20:14.547" + } + ] } } } @@ -766,10 +880,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExportCustomJob", - "x-maturity": [ - "GA" - ] + "operationId": "ListExportCustomJob" }, "post": { "description": "", @@ -790,6 +901,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export.export_custom_job" + }, + "examples": { + "create": { + "value": { + "start_day": "start_day", + "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "webhook_method": "webhook_method", + "details": {}, + "end_day": "end_day", + "webhook_url": "webhook_url", + "email": "email", + "resource_type": "resource_type", + "job_queue_position": "1", + "estimated_completion_time": "2021-03-15T20:20:14.547" + } + } } } }, @@ -802,9 +930,6 @@ } ], "operationId": "CreateExportCustomJob", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -842,6 +967,18 @@ "EndDay", "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "EndDay": "end_day_value", + "StartDay": "start_day_value", + "WebhookUrl": "webhook_url_value", + "WebhookMethod": "webhook_method_value", + "FriendlyName": "friendly_name_value", + "Email": "email_value" + } + } } } } @@ -854,7 +991,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -869,8 +1006,8 @@ "webhook_method", "webhook_url" ], - "pathType": "instance", - "parent": "/Exports" + "parent": "/Exports", + "pathType": "instance" }, "get": { "description": "", @@ -894,6 +1031,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/bulkexports.v1.export.job" + }, + "examples": { + "fetch": { + "value": { + "start_day": "start_day", + "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://bulkexports.twilio.com/v1/Exports/Jobs/JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "end_day": "end_day", + "details": {}, + "webhook_url": "https://webhookexample.com", + "webhook_method": "webhook_method", + "email": "email", + "resource_type": "resource_type", + "job_queue_position": "1", + "estimated_completion_time": "2021-03-15T20:20:14.547" + } + } } } }, @@ -905,10 +1060,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchJob", - "x-maturity": [ - "GA" - ] + "operationId": "FetchJob" }, "delete": { "description": "", @@ -936,10 +1088,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteJob", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteJob" } }, "/v1/Exports/Jobs": { @@ -948,7 +1097,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -963,8 +1112,8 @@ "webhook_method", "webhook_url" ], - "pathType": "list", - "parent": "/Exports" + "parent": "/Exports", + "pathType": "list" } } }, @@ -972,11 +1121,5 @@ { "url": "https://bulkexports.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index d06959b9..0c987985 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v1.service.channel": { "type": "object", @@ -767,12 +773,6 @@ "not_participating" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -788,7 +788,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -805,13 +805,13 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -844,6 +844,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -855,10 +880,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -895,10 +917,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -931,6 +950,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -943,9 +987,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -966,6 +1007,16 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -985,13 +1036,13 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1015,6 +1066,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -1027,9 +1103,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1055,6 +1128,16 @@ "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`." } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -1130,16 +1213,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1148,17 +1233,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1173,10 +1308,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v1/Credentials": { @@ -1240,16 +1372,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1258,17 +1392,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -1283,10 +1456,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -1296,6 +1466,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1308,9 +1492,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1351,6 +1532,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1394,6 +1582,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1405,10 +1607,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -1432,6 +1631,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1444,9 +1657,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1479,6 +1689,13 @@ "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -1510,10 +1727,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -1529,8 +1743,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1575,6 +1789,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1586,10 +1816,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -1638,10 +1865,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -1657,8 +1881,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1691,6 +1915,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1703,9 +1943,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1728,6 +1965,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1766,6 +2011,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -1811,16 +2068,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1829,17 +2088,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -1854,10 +2154,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -1873,8 +2170,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1919,6 +2216,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1930,10 +2244,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -1982,10 +2293,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -2030,6 +2338,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 666, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2042,9 +2382,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2065,6 +2402,18 @@ "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)." } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 666 + } + } } } } @@ -2084,8 +2433,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2118,6 +2467,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2130,9 +2496,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2155,6 +2518,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio" + } + } } } } @@ -2238,16 +2608,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2256,18 +2628,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -2281,10 +2695,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -2301,8 +2712,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2350,6 +2761,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2361,10 +2791,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -2416,10 +2843,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -2467,6 +2891,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{\"test\": \"test\"}", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2479,9 +2922,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2498,6 +2938,13 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello" + } + } } } } @@ -2518,8 +2965,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2555,6 +3002,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAttributes": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2567,9 +3050,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2593,6 +3073,19 @@ "required": [ "Body" ] + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAttributes": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}" + } + } } } } @@ -2677,16 +3170,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2695,18 +3190,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -2720,10 +3259,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { @@ -2739,8 +3275,8 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2776,6 +3312,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2787,10 +3343,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -2830,10 +3383,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -2869,6 +3419,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2881,9 +3451,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2902,6 +3469,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -2921,8 +3495,8 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2946,6 +3520,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2958,9 +3552,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2990,6 +3581,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -3053,16 +3653,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3071,18 +3673,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -3096,10 +3743,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Services/{Sid}": { @@ -3115,12 +3759,12 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -3144,6 +3788,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3155,10 +3835,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -3186,10 +3863,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -3213,6 +3887,140 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": { + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template" + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": { + "on_channel_add": { + "format": "webhooks.on_channel_add.format", + "method": "webhooks.on_channel_add.method", + "url": "webhooks.on_channel_add.url" + }, + "on_channel_added": { + "format": "webhooks.on_channel_added.format", + "method": "webhooks.on_channel_added.method", + "url": "webhooks.on_channel_added.url" + }, + "on_channel_destroy": { + "format": "webhooks.on_channel_destroy.format", + "method": "webhooks.on_channel_destroy.method", + "url": "webhooks.on_channel_destroy.url" + }, + "on_channel_destroyed": { + "format": "webhooks.on_channel_destroyed.format", + "method": "webhooks.on_channel_destroyed.method", + "url": "webhooks.on_channel_destroyed.url" + }, + "on_channel_update": { + "format": "webhooks.on_channel_update.format", + "method": "webhooks.on_channel_update.method", + "url": "webhooks.on_channel_update.url" + }, + "on_channel_updated": { + "format": "webhooks.on_channel_updated.format", + "method": "webhooks.on_channel_updated.method", + "url": "webhooks.on_channel_updated.url" + }, + "on_member_add": { + "format": "webhooks.on_member_add.format", + "method": "webhooks.on_member_add.method", + "url": "webhooks.on_member_add.url" + }, + "on_member_added": { + "format": "webhooks.on_member_added.format", + "method": "webhooks.on_member_added.method", + "url": "webhooks.on_member_added.url" + }, + "on_member_remove": { + "format": "webhooks.on_member_remove.format", + "method": "webhooks.on_member_remove.method", + "url": "webhooks.on_member_remove.url" + }, + "on_member_removed": { + "format": "webhooks.on_member_removed.format", + "method": "webhooks.on_member_removed.method", + "url": "webhooks.on_member_removed.url" + }, + "on_message_remove": { + "format": "webhooks.on_message_remove.format", + "method": "webhooks.on_message_remove.method", + "url": "webhooks.on_message_remove.url" + }, + "on_message_removed": { + "format": "webhooks.on_message_removed.format", + "method": "webhooks.on_message_removed.method", + "url": "webhooks.on_message_removed.url" + }, + "on_message_send": { + "format": "webhooks.on_message_send.format", + "method": "webhooks.on_message_send.method", + "url": "webhooks.on_message_send.url" + }, + "on_message_sent": { + "format": "webhooks.on_message_sent.format", + "method": "webhooks.on_message_sent.method", + "url": "webhooks.on_message_sent.url" + }, + "on_message_update": { + "format": "webhooks.on_message_update.format", + "method": "webhooks.on_message_update.method", + "url": "webhooks.on_message_update.url" + }, + "on_message_updated": { + "format": "webhooks.on_message_updated.format", + "method": "webhooks.on_message_updated.method", + "url": "webhooks.on_message_updated.url" + } + } + } + } } } }, @@ -3225,9 +4033,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3635,6 +4440,84 @@ "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000." } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Webhooks.OnChannelAdd.Format": "webhooks.on_channel_add.format", + "Webhooks.OnChannelAdd.Method": "webhooks.on_channel_add.method", + "Webhooks.OnChannelAdd.Url": "webhooks.on_channel_add.url", + "Webhooks.OnChannelAdded.Format": "webhooks.on_channel_added.format", + "Webhooks.OnChannelAdded.Method": "webhooks.on_channel_added.method", + "Webhooks.OnChannelAdded.Url": "webhooks.on_channel_added.url", + "Webhooks.OnChannelDestroy.Format": "webhooks.on_channel_destroy.format", + "Webhooks.OnChannelDestroy.Method": "webhooks.on_channel_destroy.method", + "Webhooks.OnChannelDestroy.Url": "webhooks.on_channel_destroy.url", + "Webhooks.OnChannelDestroyed.Format": "webhooks.on_channel_destroyed.format", + "Webhooks.OnChannelDestroyed.Method": "webhooks.on_channel_destroyed.method", + "Webhooks.OnChannelDestroyed.Url": "webhooks.on_channel_destroyed.url", + "Webhooks.OnChannelUpdate.Format": "webhooks.on_channel_update.format", + "Webhooks.OnChannelUpdate.Method": "webhooks.on_channel_update.method", + "Webhooks.OnChannelUpdate.Url": "webhooks.on_channel_update.url", + "Webhooks.OnChannelUpdated.Format": "webhooks.on_channel_updated.format", + "Webhooks.OnChannelUpdated.Method": "webhooks.on_channel_updated.method", + "Webhooks.OnChannelUpdated.Url": "webhooks.on_channel_updated.url", + "Webhooks.OnMemberAdd.Format": "webhooks.on_member_add.format", + "Webhooks.OnMemberAdd.Method": "webhooks.on_member_add.method", + "Webhooks.OnMemberAdd.Url": "webhooks.on_member_add.url", + "Webhooks.OnMemberAdded.Format": "webhooks.on_member_added.format", + "Webhooks.OnMemberAdded.Method": "webhooks.on_member_added.method", + "Webhooks.OnMemberAdded.Url": "webhooks.on_member_added.url", + "Webhooks.OnMemberRemove.Format": "webhooks.on_member_remove.format", + "Webhooks.OnMemberRemove.Method": "webhooks.on_member_remove.method", + "Webhooks.OnMemberRemove.Url": "webhooks.on_member_remove.url", + "Webhooks.OnMemberRemoved.Format": "webhooks.on_member_removed.format", + "Webhooks.OnMemberRemoved.Method": "webhooks.on_member_removed.method", + "Webhooks.OnMemberRemoved.Url": "webhooks.on_member_removed.url", + "Webhooks.OnMessageRemove.Format": "webhooks.on_message_remove.format", + "Webhooks.OnMessageRemove.Method": "webhooks.on_message_remove.method", + "Webhooks.OnMessageRemove.Url": "webhooks.on_message_remove.url", + "Webhooks.OnMessageRemoved.Format": "webhooks.on_message_removed.format", + "Webhooks.OnMessageRemoved.Method": "webhooks.on_message_removed.method", + "Webhooks.OnMessageRemoved.Url": "webhooks.on_message_removed.url", + "Webhooks.OnMessageSend.Format": "webhooks.on_message_send.format", + "Webhooks.OnMessageSend.Method": "webhooks.on_message_send.method", + "Webhooks.OnMessageSend.Url": "webhooks.on_message_send.url", + "Webhooks.OnMessageSent.Format": "webhooks.on_message_sent.format", + "Webhooks.OnMessageSent.Method": "webhooks.on_message_sent.method", + "Webhooks.OnMessageSent.Url": "webhooks.on_message_sent.url", + "Webhooks.OnMessageUpdate.Format": "webhooks.on_message_update.format", + "Webhooks.OnMessageUpdate.Method": "webhooks.on_message_update.method", + "Webhooks.OnMessageUpdate.Url": "webhooks.on_message_update.url", + "Webhooks.OnMessageUpdated.Format": "webhooks.on_message_updated.format", + "Webhooks.OnMessageUpdated.Method": "webhooks.on_message_updated.method", + "Webhooks.OnMessageUpdated.Url": "webhooks.on_message_updated.url" + } + } } } } @@ -3654,12 +4537,12 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -3669,6 +4552,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3681,9 +4600,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3699,6 +4615,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -3750,16 +4673,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3768,18 +4693,179 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "user_channels": 250, + "channel_members": 100, + "actions_per_second": 30 + }, + "links": { + "channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": { + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "log_enabled": true, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template" + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": { + "on_channel_add": { + "format": "webhooks.on_channel_add.format", + "method": "webhooks.on_channel_add.method", + "url": "webhooks.on_channel_add.url" + }, + "on_channel_added": { + "format": "webhooks.on_channel_added.format", + "method": "webhooks.on_channel_added.method", + "url": "webhooks.on_channel_added.url" + }, + "on_channel_destroy": { + "format": "webhooks.on_channel_destroy.format", + "method": "webhooks.on_channel_destroy.method", + "url": "webhooks.on_channel_destroy.url" + }, + "on_channel_destroyed": { + "format": "webhooks.on_channel_destroyed.format", + "method": "webhooks.on_channel_destroyed.method", + "url": "webhooks.on_channel_destroyed.url" + }, + "on_channel_update": { + "format": "webhooks.on_channel_update.format", + "method": "webhooks.on_channel_update.method", + "url": "webhooks.on_channel_update.url" + }, + "on_channel_updated": { + "format": "webhooks.on_channel_updated.format", + "method": "webhooks.on_channel_updated.method", + "url": "webhooks.on_channel_updated.url" + }, + "on_member_add": { + "format": "webhooks.on_member_add.format", + "method": "webhooks.on_member_add.method", + "url": "webhooks.on_member_add.url" + }, + "on_member_added": { + "format": "webhooks.on_member_added.format", + "method": "webhooks.on_member_added.method", + "url": "webhooks.on_member_added.url" + }, + "on_member_remove": { + "format": "webhooks.on_member_remove.format", + "method": "webhooks.on_member_remove.method", + "url": "webhooks.on_member_remove.url" + }, + "on_member_removed": { + "format": "webhooks.on_member_removed.format", + "method": "webhooks.on_member_removed.method", + "url": "webhooks.on_member_removed.url" + }, + "on_message_remove": { + "format": "webhooks.on_message_remove.format", + "method": "webhooks.on_message_remove.method", + "url": "webhooks.on_message_remove.url" + }, + "on_message_removed": { + "format": "webhooks.on_message_removed.format", + "method": "webhooks.on_message_removed.method", + "url": "webhooks.on_message_removed.url" + }, + "on_message_send": { + "format": "webhooks.on_message_send.format", + "method": "webhooks.on_message_send.method", + "url": "webhooks.on_message_send.url" + }, + "on_message_sent": { + "format": "webhooks.on_message_sent.format", + "method": "webhooks.on_message_sent.method", + "url": "webhooks.on_message_sent.url" + }, + "on_message_update": { + "format": "webhooks.on_message_update.format", + "method": "webhooks.on_message_update.method", + "url": "webhooks.on_message_update.url" + }, + "on_message_updated": { + "format": "webhooks.on_message_updated.format", + "method": "webhooks.on_message_updated.method", + "url": "webhooks.on_message_updated.url" + } + } + } + ] } } } @@ -3793,10 +4879,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { @@ -3812,11 +4895,11 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3849,6 +4932,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3860,10 +4965,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -3900,10 +5002,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -3936,6 +5035,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3948,9 +5069,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3974,6 +5092,15 @@ "description": "A descriptive string that you create to describe the resource. It is often used for display purposes." } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -3993,11 +5120,11 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4021,6 +5148,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v1.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4033,9 +5182,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4066,6 +5212,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4129,16 +5285,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4147,18 +5305,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -4172,10 +5377,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -4184,15 +5386,15 @@ "url": "https://chat.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "channel_sid", "status" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "list" }, "get": { "description": "List all Channels for a given User.", @@ -4261,16 +5463,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4279,18 +5483,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "links": { + "channel": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -4304,10 +5550,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } } }, @@ -4315,11 +5558,5 @@ { "url": "https://chat.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index c4407493..294c3772 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v2.service.binding": { "type": "object", @@ -1125,12 +1131,6 @@ "false" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1146,7 +1146,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1163,8 +1163,8 @@ "endpoint", "identity" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1247,16 +1247,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1265,18 +1267,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -1290,10 +1342,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { @@ -1309,8 +1358,8 @@ "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1346,6 +1395,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + } } } }, @@ -1357,10 +1431,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", @@ -1400,10 +1471,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBinding" } }, "/v2/Services/{ServiceSid}/Channels/{Sid}": { @@ -1419,14 +1487,14 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}", "webhook": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1459,6 +1527,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1470,10 +1564,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -1519,10 +1610,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -1564,6 +1652,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1576,9 +1690,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1613,6 +1724,19 @@ "description": "The `identity` of the User that created the channel. Default is: `system`." } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1632,14 +1756,14 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}", "webhook": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1672,6 +1796,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1684,9 +1834,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1726,6 +1873,19 @@ "description": "The `identity` of the User that created the channel. Default is: `system`." } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1801,16 +1961,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1819,17 +1981,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1844,10 +2057,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { @@ -1862,8 +2072,8 @@ "sid", "configuration" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1932,16 +2142,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1950,18 +2162,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -1975,10 +2267,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelWebhook" }, "post": { "description": "", @@ -2011,6 +2300,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2023,9 +2335,6 @@ } ], "operationId": "CreateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2076,6 +2385,20 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "webhook", + "Configuration.Url": "dummy", + "Configuration.Method": "GET", + "Configuration.Filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "Configuration.RetryCount": 2 + } + } } } } @@ -2094,8 +2417,8 @@ "sid", "configuration" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2140,6 +2463,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2151,10 +2491,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannelWebhook" }, "post": { "description": "", @@ -2199,6 +2536,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2211,9 +2571,6 @@ } ], "operationId": "UpdateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2256,6 +2613,19 @@ "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0." } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "dummy", + "Configuration.Method": "POST", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ], + "Configuration.RetryCount": 5 + } + } } } } @@ -2308,10 +2678,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { @@ -2375,16 +2742,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2393,17 +2762,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -2418,10 +2826,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -2431,6 +2836,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2443,9 +2862,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2486,6 +2902,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -2529,6 +2952,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2540,10 +2977,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -2567,6 +3001,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2579,9 +3027,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2614,6 +3059,13 @@ "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -2645,10 +3097,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -2664,8 +3113,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2710,6 +3159,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2721,10 +3186,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -2773,10 +3235,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -2792,8 +3251,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2826,6 +3285,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2838,9 +3313,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2863,6 +3335,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2901,6 +3381,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -2946,16 +3438,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2964,17 +3458,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -2989,10 +3524,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -3008,8 +3540,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3051,6 +3583,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3062,10 +3612,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -3120,10 +3667,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -3174,6 +3718,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 20, + "last_consumption_timestamp": "2016-03-24T21:05:52Z", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3186,9 +3748,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3228,6 +3787,18 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2016-03-24T21:05:50Z", + "DateUpdated": "2016-03-24T21:05:51Z", + "LastConsumedMessageIndex": 20, + "LastConsumptionTimestamp": "2016-03-24T21:05:52Z", + "Attributes": "{}" + } + } } } } @@ -3247,8 +3818,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3290,6 +3861,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3302,9 +3891,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3351,6 +3937,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio", + "Attributes": "{}" + } + } } } } @@ -3434,16 +4028,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3452,18 +4048,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -3477,10 +4116,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -3497,8 +4133,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3543,6 +4179,53 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3554,10 +4237,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -3615,10 +4295,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -3672,6 +4349,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"foo\": \"bar\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "fromUser", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3684,9 +4383,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3721,6 +4417,18 @@ "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username", + "From": "fromUser" + } + } } } } @@ -3741,8 +4449,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3784,6 +4492,73 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAll": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "system", + "attributes": "{\"test\": \"test\"}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3796,9 +4571,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3840,6 +4612,27 @@ "description": "The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message." } } + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAll": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username" + } + }, + "createMedia": { + "value": { + "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3921,16 +4714,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3939,18 +4734,88 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -3964,10 +4829,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v2/Services/{ServiceSid}/Roles/{Sid}": { @@ -3983,8 +4845,8 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4020,6 +4882,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4031,10 +4913,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -4074,10 +4953,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -4113,6 +4989,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4125,9 +5021,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4146,6 +5039,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -4165,8 +5065,8 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4190,6 +5090,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4202,9 +5122,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4234,6 +5151,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -4297,16 +5223,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4315,18 +5243,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -4340,10 +5313,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v2/Services/{Sid}": { @@ -4359,13 +5329,13 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}", "binding": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -4389,6 +5359,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4400,10 +5412,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -4431,10 +5440,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -4458,6 +5464,67 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": { + "log_enabled": true, + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template", + "badge_count_enabled": true + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "new media compatibility message" + } + } + } } } }, @@ -4470,9 +5537,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4628,6 +5692,41 @@ "description": "Whether to log notifications. The default is `false`." } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.NewMessage.BadgeCountEnabled": true, + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Notifications.LogEnabled": true, + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "PreWebhookRetryCount": 2, + "PostWebhookRetryCount": 3, + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Media.CompatibilityMessage": "new media compatibility message" + } + } } } } @@ -4647,13 +5746,13 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}", "binding": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -4663,6 +5762,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4675,9 +5816,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4693,6 +5831,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -4744,16 +5889,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4762,18 +5909,85 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + ] } } } @@ -4787,10 +6001,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { @@ -4807,12 +6018,12 @@ "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}", "user_binding": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4845,6 +6056,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4856,10 +6090,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -4896,10 +6127,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -4941,6 +6169,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4953,9 +6204,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4979,6 +6227,15 @@ "description": "A descriptive string that you create to describe the resource. It is often used for display purposes." } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4999,12 +6256,12 @@ "identity", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}", "user_binding": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -5037,6 +6294,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5049,9 +6329,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5082,6 +6359,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -5145,16 +6432,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5163,18 +6452,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -5188,10 +6525,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { @@ -5208,9 +6542,9 @@ "identity", "binding_type" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "list" }, "get": { "description": "", @@ -5291,16 +6625,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5309,18 +6645,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -5334,10 +6718,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { @@ -5354,9 +6735,9 @@ "identity", "binding_type" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "instance" }, "get": { "description": "", @@ -5401,6 +6782,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user.user_binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5412,10 +6816,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserBinding" }, "delete": { "description": "", @@ -5464,10 +6865,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -5482,9 +6880,9 @@ "channel_sid", "status" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "list" }, "get": { "description": "List all Channels for a given User.", @@ -5553,16 +6951,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5571,18 +6971,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -5596,10 +7041,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { @@ -5614,9 +7056,9 @@ "channel_sid", "status" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "instance" }, "get": { "description": "", @@ -5658,6 +7100,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user.user_channel" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5669,10 +7131,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserChannel" }, "delete": { "description": "Removes User from selected Channel.", @@ -5727,10 +7186,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserChannel" }, "post": { "description": "", @@ -5772,6 +7228,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v2.service.user.user_channel" + }, + "examples": { + "updateNotificationLevel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 10, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5784,9 +7278,6 @@ } ], "operationId": "UpdateUserChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5810,6 +7301,18 @@ "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels)." } } + }, + "examples": { + "updateNotificationLevel": { + "value": { + "NotificationLevel": "muted" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 10 + } + } } } } @@ -5821,11 +7324,5 @@ { "url": "https://chat.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index d285462f..d85420f0 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v3.channel": { "type": "object", @@ -106,12 +112,6 @@ "false" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -127,7 +127,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -186,6 +186,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/chat.v3.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://chat.twilio.com/v3/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -198,9 +218,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -221,6 +238,14 @@ "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to." } } + }, + "examples": { + "update": { + "value": { + "Type": "private", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -248,11 +273,5 @@ { "url": "https://chat.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_content_v1.json b/spec/json/twilio_content_v1.json index de32f0ec..2cc23505 100644 --- a/spec/json/twilio_content_v1.json +++ b/spec/json/twilio_content_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "content.v1.content.approval_fetch": { "type": "object", @@ -217,12 +223,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -238,7 +238,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -255,9 +255,9 @@ "account_sid", "whatsapp" ], - "pathType": "instance", "parent": "/Content/{Sid}", - "mountName": "approval_fetch" + "mountName": "approval_fetch", + "pathType": "instance" }, "get": { "description": "Fetch a Content resource's approval status by its unique Content Sid", @@ -281,6 +281,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/content.v1.content.approval_fetch" + }, + "examples": { + "getApproval": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "whatsapp": { + "type": "whatsapp", + "name": "tree_fiddy", + "category": "ACCOUNT_UPDATE", + "content_type": "twilio/location", + "status": "approved", + "rejection_reason": "", + "allow_category_change": true + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } } } }, @@ -292,10 +310,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApprovalFetch", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchApprovalFetch" } }, "/v1/Content/{Sid}": { @@ -316,12 +331,12 @@ "variables", "types" ], - "pathType": "instance", "dependentProperties": { - "content/v1/approval_create": "{sid: sid}", + "approval_create": "{sid: sid}", "approval_fetch": "{sid: sid}" }, - "mountName": "contents" + "mountName": "contents", + "pathType": "instance" }, "get": { "description": "Fetch a Content resource by its unique Content Sid", @@ -345,6 +360,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/content.v1.content" + }, + "examples": { + "fetch": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + } } } }, @@ -356,10 +401,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchContent", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchContent" }, "delete": { "description": "Deletes a Content resource", @@ -387,10 +429,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteContent", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteContent" } }, "/v1/Content": { @@ -411,12 +450,12 @@ "variables", "types" ], - "pathType": "list", "dependentProperties": { - "content/v1/approval_create": "{sid: sid}", + "approval_create": "{sid: sid}", "approval_fetch": "{sid: sid}" }, - "mountName": "contents" + "mountName": "contents", + "pathType": "list" }, "get": { "description": "Retrieve a list of Contents belonging to the account used to make the request", @@ -464,16 +503,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -482,17 +523,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/Content?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/Content?PageSize=10&Page=0", + "next_page_url": null, + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Anotha content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Third content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/Content?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/Content?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" } } } @@ -507,10 +655,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListContent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListContent" } }, "/v1/ContentAndApprovals": { @@ -532,8 +677,8 @@ "types", "approval_requests" ], - "pathType": "list", - "className": "content_and_approvals" + "className": "content_and_approvals", + "pathType": "list" }, "get": { "description": "Retrieve a list of Contents with approval statuses belonging to the account used to make the request", @@ -581,16 +726,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -599,17 +746,132 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0", + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "approval_requests": { + "name": "", + "category": "", + "content_type": "", + "status": "unsubmitted", + "rejection_reason": "", + "allow_category_change": true + } + }, + { + "language": "en", + "date_updated": "2023-01-13T23:33:46Z", + "variables": { + "1": "name", + "2": "typedocument" + }, + "friendly_name": "Media Test", + "account_sid": "AC25c0d4b9093547216c460212e24e77ee", + "sid": "HX5fcd48a417c1cb59da349ad6d5da4607", + "date_created": "2023-01-13T23:33:46Z", + "types": { + "twilio/media": { + "body": "{{1}}, Congratulations {{2}}! For additional assistance, please contact us at hello@twilio.com", + "media": [ + "https://example.com/template" + ] + } + }, + "approval_requests": { + "category": "TRANSACTIONAL", + "status": "approved", + "rejection_reason": "", + "name": "Media Test", + "content_type": "twilio/media", + "allow_category_change": false + } + }, + { + "language": "en", + "date_updated": "2023-01-18T02:46:35Z", + "variables": { + "1": "name", + "2": "type_video", + "3": "small.mp4" + }, + "friendly_name": "Video Highlights", + "account_sid": "AC25c0d4b9093547216c460212e24e77ee", + "sid": "HX15c711fcc6d9ea5268d7ab77938a20ff", + "date_created": "2023-01-18T02:46:35Z", + "types": { + "twilio/media": { + "body": "Hi there, {{1}}, we have received your request to upload {{2}}, and should be uploaded shortly.", + "media": [ + "http://example.com/highlights/{{3}}" + ] + } + }, + "approval_requests": { + "category": "TRANSACTIONAL", + "status": "rejected", + "rejection_reason": "INVALID_FORMAT. Facebook is not able to create template with templateName=Video Highlights_hx15c711fcc6d9ea5268d7ab77938a20ff due to the following error: Invalid parameter. More Details: Message template 'components' param is missing expected field(s). component of type HEADER is missing expected field(s) (example)", + "name": "Video Highlights", + "content_type": "twilio/media", + "allow_category_change": true + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0", + "url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "contents" } } } @@ -624,10 +886,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListContentAndApprovals", - "x-maturity": [ - "Preview" - ] + "operationId": "ListContentAndApprovals" } }, "/v1/LegacyContent": { @@ -650,8 +909,8 @@ "legacy_template_name", "legacy_body" ], - "pathType": "list", - "mountName": "legacy_contents" + "mountName": "legacy_contents", + "pathType": "list" }, "get": { "description": "Retrieve a list of Legacy Contents belonging to the account used to make the request", @@ -699,16 +958,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -717,17 +978,118 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0", + "next_page_url": null, + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_1", + "legacy_body": "a body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Anotha content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_2", + "legacy_body": "another body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Third content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_3", + "legacy_body": "a third body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" } } } @@ -742,10 +1104,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListLegacyContent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListLegacyContent" } } }, @@ -753,11 +1112,5 @@ { "url": "https://content.twilio.com" } - ], - "x-maturity": [ - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index e46a57db..8e2f8f19 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "conversations.v1.configuration": { "type": "object", @@ -668,6 +674,20 @@ "POST" ] }, + "conversation_webhook_enum_target": { + "type": "string", + "enum": [ + "webhook", + "flex" + ] + }, + "conversation_webhook_enum_method": { + "type": "string", + "enum": [ + "GET", + "POST" + ] + }, "conversations.v1.credential": { "type": "object", "properties": { @@ -2332,12 +2352,6 @@ "closed" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2353,7 +2367,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -2380,6 +2394,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_inactive_timer": "PT1M", + "default_closed_timer": "PT10M", + "url": "https://conversations.twilio.com/v1/Configuration", + "links": { + "service": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "webhooks": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } + } } } }, @@ -2391,10 +2421,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfiguration" }, "post": { "description": "Update the global configuration of conversations on your account", @@ -2404,6 +2431,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_inactive_timer": "PT1M", + "default_closed_timer": "PT10M", + "url": "https://conversations.twilio.com/v1/Configuration", + "links": { + "service": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "webhooks": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } + } } } }, @@ -2416,9 +2459,6 @@ } ], "operationId": "UpdateConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2449,6 +2489,16 @@ "description": "Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." } } + }, + "examples": { + "update": { + "value": { + "DefaultChatServiceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultMessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultInactiveTimer": "PT1M", + "DefaultClosedTimer": "PT10M" + } + } } } } @@ -2469,8 +2519,8 @@ "address", "friendly_name" ], - "pathType": "list", - "mountName": "address_configurations" + "mountName": "address_configurations", + "pathType": "list" }, "get": { "description": "Retrieve a list of address configurations for an account", @@ -2481,6 +2531,11 @@ "description": "Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.", "schema": { "type": "string" + }, + "examples": { + "readByAddressType": { + "value": "sms" + } } }, { @@ -2526,16 +2581,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2544,18 +2601,172 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "next_page_url": null, + "key": "address_configurations" + }, + "address_configurations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "address": "+37256123458", + "type": "sms", + "friendly_name": "Studio Test Configuration", + "address_country": "US", + "auto_creation": { + "enabled": false, + "type": "studio", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "address": "+37256123459", + "type": "sms", + "friendly_name": "Default Test Configuration", + "address_country": "NG", + "auto_creation": { + "enabled": true, + "type": "default" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } + ] + } + }, + "readBlank": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "address_configurations" + }, + "address_configurations": [] + } + }, + "readByAddressType": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0", + "next_page_url": null, + "key": "address_configurations" + }, + "address_configurations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "address": "+37256123458", + "type": "sms", + "friendly_name": "Studio Test Configuration", + "address_country": "US", + "auto_creation": { + "enabled": false, + "type": "studio", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "address": "+37256123459", + "type": "sms", + "friendly_name": "Default Test Configuration", + "address_country": "NG", + "auto_creation": { + "enabled": true, + "type": "default" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac" + } + ] } } } @@ -2569,10 +2780,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListConfigurationAddress" }, "post": { "description": "Create a new address configuration", @@ -2582,6 +2790,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration_address" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2594,9 +2828,6 @@ } ], "operationId": "CreateConfigurationAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2669,6 +2900,25 @@ "Type", "Address" ] + }, + "examples": { + "create": { + "value": { + "Address": "+37256123457", + "Type": "sms", + "FriendlyName": "My Test Configuration", + "AutoCreation.Enabled": true, + "AutoCreation.Type": "webhook", + "AutoCreation.ConversationServiceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AutoCreation.WebhookUrl": "https://example.com", + "AutoCreation.WebhookMethod": "POST", + "AutoCreation.WebhookFilters": [ + "onParticipantAdded", + "onMessageAdded" + ], + "AddressCountry": "CA" + } + } } } } @@ -2689,8 +2939,8 @@ "address", "friendly_name" ], - "pathType": "instance", - "mountName": "address_configurations" + "mountName": "address_configurations", + "pathType": "instance" }, "get": { "description": "Fetch an address configuration ", @@ -2711,6 +2961,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration_address" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration", + "address_country": "CA", + "auto_creation": { + "enabled": true, + "type": "webhook", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "https://example.com", + "webhook_method": "POST", + "webhook_filters": [ + "onParticipantAdded", + "onMessageAdded" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2722,10 +2998,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfigurationAddress" }, "post": { "description": "Update an existing address configuration", @@ -2746,6 +3019,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration_address" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "+37256123457", + "type": "sms", + "friendly_name": "My Test Configuration Updated", + "address_country": "CA", + "auto_creation": { + "enabled": false, + "type": "studio", + "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "studio_retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2758,9 +3053,6 @@ } ], "operationId": "UpdateConfigurationAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2816,6 +3108,17 @@ "description": "For type `studio`, number of times to retry the webhook request" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "My Test Configuration Updated", + "AutoCreation.Enabled": false, + "AutoCreation.Type": "studio", + "AutoCreation.StudioFlowSid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AutoCreation.StudioRetryCount": 3 + } + } } } } @@ -2844,10 +3147,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConfigurationAddress" } }, "/v1/Configuration/Webhooks": { @@ -2864,8 +3164,8 @@ "pre_webhook_url", "post_webhook_url" ], - "pathType": "instance", - "parent": "/Configuration" + "parent": "/Configuration", + "pathType": "instance" }, "get": { "description": "", @@ -2875,6 +3175,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration.configuration_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://example.com/pre", + "post_webhook_url": "https://example.com/post", + "method": "GET", + "filters": [ + "onMessageSend", + "onConversationUpdated" + ], + "target": "webhook", + "url": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } } } }, @@ -2886,10 +3202,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfigurationWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfigurationWebhook" }, "post": { "description": "", @@ -2899,6 +3212,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.configuration.configuration_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://example.com/pre", + "post_webhook_url": "http://example.com/post", + "method": "GET", + "filters": [ + "onConversationUpdated" + ], + "target": "webhook", + "url": "https://conversations.twilio.com/v1/Configuration/Webhooks" + } + } } } }, @@ -2911,9 +3239,6 @@ } ], "operationId": "UpdateConfigurationWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2946,6 +3271,19 @@ "description": "The routing target of the webhook." } } + }, + "examples": { + "update": { + "value": { + "PreWebhookUrl": "https://example.com/pre", + "PostWebhookUrl": "https://example.com/post", + "Method": "GET", + "Filters": [ + "onConversationUpdated" + ], + "Target": "webhook" + } + } } } } @@ -2966,12 +3304,12 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "participant": "{conversation_sid: sid}", "message": "{conversation_sid: sid}", "webhook": "{conversation_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new conversation in your account's default service", @@ -2992,6 +3330,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + }, + "createNoTimersNoAttributes": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": null, + "attributes": "{}", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "state": "active", + "timers": {}, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -3004,9 +3391,6 @@ } ], "operationId": "CreateConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3057,6 +3441,30 @@ "description": "ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"topic\": \"feedback\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "State": "inactive", + "Timers.Inactive": "PT1M", + "Timers.Closed": "PT10M" + } + }, + "createNoTimersNoAttributes": { + "value": { + "FriendlyName": "friendly_name", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "State": "active" + } + } } } } @@ -3133,16 +3541,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3151,17 +3561,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "conversations": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Home Repair Visit", + "unique_name": null, + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -3176,10 +3624,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversation" } }, "/v1/Conversations/{Sid}": { @@ -3196,12 +3641,12 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "participant": "{conversation_sid: sid}", "message": "{conversation_sid: sid}", "webhook": "{conversation_sid: sid}" - } + }, + "pathType": "instance" }, "post": { "description": "Update an existing conversation in your account's default service", @@ -3231,6 +3676,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -3243,9 +3715,6 @@ } ], "operationId": "UpdateConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3296,6 +3765,21 @@ "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." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"topic\": \"feedback\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "State": "inactive", + "Timers.Inactive": "PT1M", + "Timers.Closed": "PT10M" + } + } } } } @@ -3333,10 +3817,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversation" }, "get": { "description": "Fetch a conversation from your account's default service", @@ -3357,6 +3838,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My First Conversation", + "unique_name": "first_conversation", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -3368,10 +3876,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversation" } }, "/v1/Conversations/{ConversationSid}/Messages": { @@ -3388,11 +3893,11 @@ "author", "date_created" ], - "pathType": "list", "dependentProperties": { "delivery_receipt": "{conversation_sid: conversation_sid, message_sid: sid}" }, - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new message to the conversation", @@ -3422,6 +3927,127 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + }, + "createWithMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": null, + "media": [ + { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 42056, + "content_type": "image/jpeg", + "filename": "car.jpg" + } + ], + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + }, + "createNoAttributes": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + }, + "createWithContentSid": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello John", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + } } } }, @@ -3434,9 +4060,6 @@ } ], "operationId": "CreateConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3485,6 +4108,43 @@ "description": "A structurally valid JSON string that contains values to resolve Rich Content template variables." } } + }, + "examples": { + "create": { + "value": { + "Body": "Hello", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createWithMedia": { + "value": { + "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createNoAttributes": { + "value": { + "Body": "Hello", + "Author": "message author", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + }, + "createWithContentSid": { + "value": { + "Author": "message author", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "ContentSid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ContentVariables": "{\"name\": \"John\"}" + } + } } } } @@ -3509,6 +4169,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/conversation_message_enum_order_type" + }, + "examples": { + "readLastMessage": { + "value": "desc" + } } }, { @@ -3554,16 +4219,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3572,18 +4239,166 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "I like pie.", + "media": null, + "author": "pie_preferrer", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Cake is my favorite!", + "media": null, + "author": "cake_lover", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:38:21Z", + "date_updated": "2016-03-24T20:38:21Z", + "index": 5, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": null, + "media": [ + { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 42056, + "content_type": "image/jpeg", + "filename": "car.jpg" + } + ], + "author": "cake_lover", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:38:21Z", + "date_updated": "2016-03-24T20:38:21Z", + "index": 9, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + ] + } + }, + "readLastMessage": { + "value": { + "meta": { + "page": 0, + "page_size": 1, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0", + "next_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=1&PageToken=PAIMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": null, + "media": [ + { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 42056, + "content_type": "image/jpeg", + "filename": "car.jpg" + } + ], + "author": "cake_lover", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:38:21Z", + "date_updated": "2016-03-24T20:38:21Z", + "index": 9, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + ] } } } @@ -3597,10 +4412,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationMessage" } }, "/v1/Conversations/{ConversationSid}/Messages/{Sid}": { @@ -3617,11 +4429,11 @@ "author", "date_created" ], - "pathType": "instance", "dependentProperties": { "delivery_receipt": "{conversation_sid: conversation_sid, message_sid: sid}" }, - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing message in the conversation", @@ -3663,6 +4475,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + } } } }, @@ -3675,9 +4517,6 @@ } ], "operationId": "UpdateConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3708,6 +4547,17 @@ "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + } } } } @@ -3757,10 +4607,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationMessage" }, "get": { "description": "Fetch a message from the conversation", @@ -3793,6 +4640,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Welcome!", + "media": null, + "author": "system", + "participant_sid": null, + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + } } } }, @@ -3804,10 +4681,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationMessage" } }, "/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}": { @@ -3824,9 +4698,9 @@ "status", "date_created" ], - "pathType": "instance", "parent": "/Conversations/{ConversationSid}/Messages/{Sid}", - "mountName": "delivery_receipts" + "mountName": "delivery_receipts", + "pathType": "instance" }, "get": { "description": "Fetch the delivery and read receipts of the conversation message", @@ -3871,6 +4745,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt" + }, + "examples": { + "fetch": { + "value": { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3882,10 +4773,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationMessageReceipt" } }, "/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts": { @@ -3902,9 +4790,9 @@ "status", "date_created" ], - "pathType": "list", "parent": "/Conversations/{ConversationSid}/Messages/{Sid}", - "mountName": "delivery_receipts" + "mountName": "delivery_receipts", + "pathType": "list" }, "get": { "description": "Retrieve a list of all delivery and read receipts of the conversation message", @@ -3973,16 +4861,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3991,18 +4881,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "next_page_url": null, + "key": "delivery_receipts" + }, + "delivery_receipts": [ + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -4016,10 +4960,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationMessageReceipt" } }, "/v1/Conversations/{ConversationSid}/Participants": { @@ -4034,8 +4975,8 @@ "sid", "messaging_binding" ], - "pathType": "list", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new participant to the conversation", @@ -4065,6 +5006,101 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" + }, + "examples": { + "createSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createChat": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsChatNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "address": "+15017122661" + }, + "role_sid": null, + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -4077,9 +5113,6 @@ } ], "operationId": "CreateConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4125,6 +5158,53 @@ "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." } } + }, + "examples": { + "createSms": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.Address": "+15558675310", + "MessagingBinding.ProxyAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createChat": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmms": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmmsChatNoAttributes": { + "value": { + "Identity": "IDENTITY", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "MessagingBinding.Address": "+15017122661", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + } } } } @@ -4185,16 +5265,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4203,18 +5285,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + ] } } } @@ -4228,10 +5357,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationParticipant" } }, "/v1/Conversations/{ConversationSid}/Participants/{Sid}": { @@ -4246,8 +5372,8 @@ "sid", "messaging_binding" ], - "pathType": "instance", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing participant in the conversation", @@ -4286,10 +5412,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" - } - } - }, - "description": "OK" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "updateGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "id", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -4298,9 +5465,6 @@ } ], "operationId": "UpdateConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4351,6 +5515,21 @@ "description": "Timestamp of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." } } + }, + "examples": { + "update": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "updateGmms": { + "value": { + "MessagingBinding.ProjectedAddress": "+15017122661" + } + } } } } @@ -4397,10 +5576,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationParticipant" }, "get": { "description": "Fetch a participant of the conversation", @@ -4430,6 +5606,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -4441,10 +5639,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationParticipant" } }, "/v1/Conversations/{ConversationSid}/Webhooks": { @@ -4459,8 +5654,8 @@ "sid", "target" ], - "pathType": "list", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all webhooks scoped to the conversation", @@ -4517,16 +5712,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4535,18 +5732,93 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -4560,10 +5832,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationScopedWebhook" }, "post": { "description": "Create a new webhook scoped to the conversation", @@ -4584,6 +5853,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4596,9 +5886,6 @@ } ], "operationId": "CreateConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4649,6 +5936,20 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "Target": "webhook", + "Configuration.Url": "https://example.com", + "Configuration.Method": "get", + "Configuration.Filters": [ + "onMessageSent", + "onConversationDestroyed" + ], + "Configuration.ReplayAfter": 7 + } + } } } } @@ -4667,8 +5968,8 @@ "sid", "target" ], - "pathType": "instance", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch the configuration of a conversation-scoped webhook", @@ -4701,6 +6002,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4712,10 +6029,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationScopedWebhook" }, "post": { "description": "Update an existing conversation-scoped webhook", @@ -4748,6 +6062,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4760,9 +6095,6 @@ } ], "operationId": "UpdateConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4801,6 +6133,18 @@ "description": "The studio flow SID, where the webhook should be sent to." } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "https://example.com", + "Configuration.Method": "post", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ] + } + } } } } @@ -4841,10 +6185,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationScopedWebhook" } }, "/v1/Credentials": { @@ -4870,6 +6211,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4882,9 +6237,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4925,6 +6277,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -4976,16 +6335,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4994,17 +6355,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -5019,10 +6419,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" } }, "/v1/Credentials/{Sid}": { @@ -5062,6 +6459,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5074,9 +6485,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5114,6 +6522,13 @@ "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -5145,10 +6560,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" }, "get": { "description": "Fetch a push notification credential from your account", @@ -5172,6 +6584,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5183,10 +6609,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" } }, "/v1/ParticipantConversations": { @@ -5213,6 +6636,14 @@ "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "identity" + }, + "readFullByIdentity": { + "value": "identity" + } } }, { @@ -5221,6 +6652,11 @@ "description": "A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.", "schema": { "type": "string" + }, + "examples": { + "readFullByAddress": { + "value": "+375255555555" + } } }, { @@ -5266,16 +6702,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5284,17 +6722,116 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByIdentity": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_identity": "identity", + "participant_messaging_binding": null, + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByAddress": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": null, + "participant_identity": null, + "participant_messaging_binding": { + "address": "+375255555555", + "proxy_address": "+12345678910", + "type": "sms", + "level": null, + "name": null, + "projected_address": null + }, + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -5309,10 +6846,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipantConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListParticipantConversation" } }, "/v1/Roles": { @@ -5338,6 +6872,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5350,9 +6904,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5382,6 +6933,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Conversation Role", + "Type": "conversation", + "Permission": "sendMessage" + } + } } } } @@ -5433,16 +6993,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5451,18 +7013,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -5476,10 +7083,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Roles/{Sid}": { @@ -5519,6 +7123,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5531,9 +7155,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5552,6 +7173,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -5583,10 +7211,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "get": { "description": "Fetch a user role from your account's default service", @@ -5610,6 +7235,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5621,10 +7266,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" } }, "/v1/Services": { @@ -5639,7 +7281,6 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "conversation": "{chat_service_sid: sid}", "binding": "{chat_service_sid: sid}", @@ -5647,7 +7288,8 @@ "role": "{chat_service_sid: sid}", "configuration": "{chat_service_sid: sid}", "participant_conversation": "{chat_service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new conversation service on your account", @@ -5657,6 +7299,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations", + "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations" + } + } + } } } }, @@ -5669,9 +7331,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5687,6 +7346,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -5738,16 +7404,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5756,17 +7424,48 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "services": [ + { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Home Service", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations", + "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0", + "next_page_url": null, + "key": "services" } } } @@ -5781,10 +7480,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -5799,7 +7495,6 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "conversation": "{chat_service_sid: sid}", "binding": "{chat_service_sid: sid}", @@ -5807,7 +7502,8 @@ "role": "{chat_service_sid: sid}", "configuration": "{chat_service_sid: sid}", "participant_conversation": "{chat_service_sid: sid}" - } + }, + "pathType": "instance" }, "delete": { "description": "Remove a conversation service with all its nested resources from your account", @@ -5835,10 +7531,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "get": { "description": "Fetch a conversation service from your account", @@ -5862,6 +7555,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My First Service", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations", + "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations" + } + } + } } } }, @@ -5873,10 +7586,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" } }, "/v1/Services/{ChatServiceSid}/Bindings/{Sid}": { @@ -5892,8 +7602,8 @@ "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Remove a push notification binding from the conversation service", @@ -5933,10 +7643,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceBinding" }, "get": { "description": "Fetch a push notification binding from the conversation service", @@ -5972,6 +7679,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_conversation", + "new_message", + "added_to_conversation" + ], + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5983,10 +7711,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceBinding" } }, "/v1/Services/{ChatServiceSid}/Bindings": { @@ -6002,8 +7727,8 @@ "endpoint", "identity" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all push notification bindings in the conversation service", @@ -6086,16 +7811,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6104,18 +7831,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_conversation", + "new_message", + "added_to_conversation" + ], + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -6129,10 +7902,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceBinding" } }, "/v1/Services/{ChatServiceSid}/Configuration": { @@ -6146,8 +7916,8 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch the configuration of a conversation service", @@ -6171,6 +7941,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration" + }, + "examples": { + "fetch": { + "value": { + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reachability_enabled": false, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "links": { + "notifications": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + } + } } } }, @@ -6182,10 +7968,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConfiguration" }, "post": { "description": "Update configuration settings of a conversation service", @@ -6209,6 +7992,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration" + }, + "examples": { + "update": { + "value": { + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_conversation_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_chat_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reachability_enabled": false, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration", + "links": { + "notifications": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + } + } } } }, @@ -6221,9 +8020,6 @@ } ], "operationId": "UpdateServiceConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6257,6 +8053,16 @@ "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Conversations Service. The default is `false`." } } + }, + "examples": { + "update": { + "value": { + "DefaultConversationCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultConversationRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChatServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ReachabilityEnabled": false + } + } } } } @@ -6277,13 +8083,13 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "participant": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", "message": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", "webhook": "{chat_service_sid: chat_service_sid, conversation_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new conversation in your service", @@ -6316,6 +8122,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + }, + "createNoTimersNoAttributes": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": null, + "attributes": "{}", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "state": "active", + "timers": {}, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -6328,9 +8183,6 @@ } ], "operationId": "CreateServiceConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6381,6 +8233,30 @@ "description": "ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"topic\": \"feedback\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "State": "inactive", + "Timers.Inactive": "PT1M", + "Timers.Closed": "PT10M" + } + }, + "createNoTimersNoAttributes": { + "value": { + "FriendlyName": "friendly_name", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "State": "active" + } + } } } } @@ -6469,16 +8345,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6487,17 +8365,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "conversations": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Home Repair Visit", + "unique_name": null, + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -6512,10 +8428,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversation" } }, "/v1/Services/{ChatServiceSid}/Conversations/{Sid}": { @@ -6532,13 +8445,13 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "participant": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", "message": "{chat_service_sid: chat_service_sid, conversation_sid: sid}", "webhook": "{chat_service_sid: chat_service_sid, conversation_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing conversation in your service", @@ -6580,6 +8493,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -6592,9 +8532,6 @@ } ], "operationId": "UpdateServiceConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6645,6 +8582,21 @@ "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." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"topic\": \"feedback\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "State": "inactive", + "Timers.Inactive": "PT1M", + "Timers.Closed": "PT10M" + } + } } } } @@ -6694,10 +8646,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversation" }, "get": { "description": "Fetch a conversation from your service", @@ -6730,6 +8679,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My First Conversation", + "unique_name": "first_conversation", + "attributes": "{ \"topic\": \"feedback\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "state": "active", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "bindings": {}, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" + } + } + } } } }, @@ -6741,10 +8717,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversation" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages": { @@ -6761,11 +8734,11 @@ "author", "date_created" ], - "pathType": "list", "dependentProperties": { "delivery_receipt": "{chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, message_sid: sid}" }, - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new message to the conversation in a specific service", @@ -6807,6 +8780,131 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + }, + "createWithMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": null, + "media": [ + { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 42056, + "content_type": "image/jpeg", + "filename": "car.jpg" + } + ], + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + }, + "createNoAttributes": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + }, + "createWithContentSid": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello John", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + } } } }, @@ -6819,9 +8917,6 @@ } ], "operationId": "CreateServiceConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6870,6 +8965,43 @@ "description": "A structurally valid JSON string that contains values to resolve Rich Content template variables." } } + }, + "examples": { + "create": { + "value": { + "Body": "Hello", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createWithMedia": { + "value": { + "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createNoAttributes": { + "value": { + "Body": "Hello", + "Author": "message author", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + }, + "createWithContentSid": { + "value": { + "Author": "message author", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "ContentSid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ContentVariables": "{\"name\": \"John\"}" + } + } } } } @@ -6906,6 +9038,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/service_conversation_message_enum_order_type" + }, + "examples": { + "readLastMessage": { + "value": "desc" + } } }, { @@ -6951,16 +9088,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6969,18 +9108,170 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "I like pie.", + "media": null, + "author": "pie_preferrer", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Cake is my favorite!", + "media": null, + "author": "cake_lover", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:38:21Z", + "date_updated": "2016-03-24T20:38:21Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": null, + "media": [ + { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 42056, + "content_type": "image/jpeg", + "filename": "car.jpg" + } + ], + "author": "cake_lover", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:38:21Z", + "date_updated": "2016-03-24T20:38:21Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + ] + } + }, + "readLastMessage": { + "value": { + "meta": { + "page": 0, + "page_size": 1, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0", + "next_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=1&PageToken=PAIMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": null, + "media": [ + { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 42056, + "content_type": "image/jpeg", + "filename": "car.jpg" + } + ], + "author": "cake_lover", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:38:21Z", + "date_updated": "2016-03-24T20:38:21Z", + "index": 9, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + ] } } } @@ -6994,10 +9285,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationMessage" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}": { @@ -7014,11 +9302,11 @@ "author", "date_created" ], - "pathType": "instance", "dependentProperties": { "delivery_receipt": "{chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, message_sid: sid}" }, - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing message in the conversation", @@ -7072,6 +9360,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Hello", + "media": null, + "author": "message author", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + } } } }, @@ -7084,9 +9403,6 @@ } ], "operationId": "UpdateServiceConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7117,6 +9433,17 @@ "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + } } } } @@ -7178,10 +9505,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationMessage" }, "get": { "description": "Fetch a message from the conversation", @@ -7226,6 +9550,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "Welcome!", + "media": null, + "author": "system", + "participant_sid": null, + "attributes": "{ \"importance\": \"high\" }", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "index": 0, + "delivery": { + "total": 2, + "sent": "all", + "delivered": "some", + "read": "some", + "failed": "none", + "undelivered": "none" + }, + "content_sid": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "delivery_receipts": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts" + } + } + } } } }, @@ -7237,10 +9592,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationMessage" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}": { @@ -7257,9 +9609,9 @@ "status", "date_created" ], - "pathType": "instance", "parent": "/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}", - "mountName": "delivery_receipts" + "mountName": "delivery_receipts", + "pathType": "instance" }, "get": { "description": "Fetch the delivery and read receipts of the conversation message", @@ -7316,6 +9668,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt" + }, + "examples": { + "fetch": { + "value": { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7327,10 +9697,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationMessageReceipt" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts": { @@ -7347,9 +9714,9 @@ "status", "date_created" ], - "pathType": "list", "parent": "/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}", - "mountName": "delivery_receipts" + "mountName": "delivery_receipts", + "pathType": "list" }, "get": { "description": "Retrieve a list of all delivery and read receipts of the conversation message", @@ -7430,16 +9797,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7448,18 +9817,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0", + "next_page_url": null, + "key": "delivery_receipts" + }, + "delivery_receipts": [ + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_message_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 3000, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -7473,10 +9899,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationMessageReceipt" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants": { @@ -7491,8 +9914,8 @@ "sid", "messaging_binding" ], - "pathType": "list", - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new participant to the conversation in a specific service", @@ -7534,6 +9957,106 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant" + }, + "examples": { + "createSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "null", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createChat": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsChatNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{}", + "messaging_binding": { + "type": "sms", + "address": "+15017122661" + }, + "role_sid": null, + "date_created": "2020-07-01T22:18:37Z", + "date_updated": "2020-07-01T22:18:37Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -7546,9 +10069,6 @@ } ], "operationId": "CreateServiceConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7594,6 +10114,53 @@ "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." } } + }, + "examples": { + "createSms": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.Address": "+15558675310", + "MessagingBinding.ProxyAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createChat": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmms": { + "value": { + "Identity": "IDENTITY", + "Attributes": "{ \"role\": \"driver\" }", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "createGmmsChatNoAttributes": { + "value": { + "Identity": "IDENTITY", + "MessagingBinding.ProjectedAddress": "+15017122661", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + }, + "createGmmsSmsNoAttributes": { + "value": { + "MessagingBinding.Address": "+15017122661", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z" + } + } } } } @@ -7666,16 +10233,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7684,18 +10253,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "IDENTITY", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": null, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + ] } } } @@ -7709,10 +10327,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationParticipant" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}": { @@ -7727,8 +10342,8 @@ "sid", "messaging_binding" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing participant in the conversation", @@ -7779,6 +10394,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + }, + "updateGmms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "id", + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "projected_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -7791,9 +10449,6 @@ } ], "operationId": "UpdateServiceConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7844,6 +10499,21 @@ "description": "Timestamp of last \u201cread\u201d message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant." } } + }, + "examples": { + "update": { + "value": { + "Attributes": "{ \"role\": \"driver\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + }, + "updateGmms": { + "value": { + "MessagingBinding.ProjectedAddress": "+15017122661" + } + } } } } @@ -7902,10 +10572,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationParticipant" }, "get": { "description": "Fetch a participant of the conversation", @@ -7947,6 +10614,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": null, + "attributes": "{ \"role\": \"driver\" }", + "messaging_binding": { + "type": "sms", + "address": "+15558675310", + "proxy_address": "+15017122661" + }, + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_read_message_index": null, + "last_read_timestamp": null + } + } } } }, @@ -7958,10 +10648,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationParticipant" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks": { @@ -7976,8 +10663,8 @@ "sid", "target" ], - "pathType": "list", - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new webhook scoped to the conversation in a specific service", @@ -8010,6 +10697,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8022,9 +10731,6 @@ } ], "operationId": "CreateServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8075,6 +10781,20 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "Target": "webhook", + "Configuration.Url": "https://example.com", + "Configuration.Method": "get", + "Configuration.Filters": [ + "onMessageSent", + "onConversationDestroyed" + ], + "Configuration.ReplayAfter": 7 + } + } } } } @@ -8147,16 +10867,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8165,18 +10887,96 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "webhook", + "configuration": { + "url": "https://example.com", + "method": "get", + "filters": [ + "onMessageSent", + "onConversationDestroyed" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -8190,10 +10990,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationScopedWebhook" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}": { @@ -8208,8 +11005,8 @@ "sid", "target" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing conversation-scoped webhook", @@ -8254,6 +11051,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "trigger", + "configuration": { + "url": "https://example.com", + "method": "post", + "filters": [ + "keyword1", + "keyword2" + ] + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8266,9 +11085,6 @@ } ], "operationId": "UpdateServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8307,6 +11123,18 @@ "description": "The studio flow SID, where the webhook should be sent to." } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "https://example.com", + "Configuration.Method": "post", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ] + } + } } } } @@ -8359,10 +11187,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationScopedWebhook" }, "get": { "description": "Fetch the configuration of a conversation-scoped webhook", @@ -8407,6 +11232,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8418,10 +11260,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationScopedWebhook" } }, "/v1/Services/{ChatServiceSid}/Configuration/Notifications": { @@ -8435,8 +11274,8 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Configuration" + "parent": "/Services/{ChatServiceSid}/Configuration", + "pathType": "instance" }, "post": { "description": "Update push notification service settings", @@ -8460,6 +11299,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_notification" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "log_enabled": true, + "added_to_conversation": { + "enabled": false, + "template": "You have been added to a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "new_message": { + "enabled": false, + "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}", + "badge_count_enabled": true, + "sound": "ring", + "with_media": { + "enabled": false, + "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}" + } + }, + "removed_from_conversation": { + "enabled": false, + "template": "You have been removed from a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications" + } + } } } }, @@ -8472,9 +11341,6 @@ } ], "operationId": "UpdateServiceNotification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8535,6 +11401,25 @@ "description": "The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`." } } + }, + "examples": { + "update": { + "value": { + "NewMessage.Enabled": false, + "NewMessage.Template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}", + "NewMessage.Sound": "ring", + "NewMessage.BadgeCountEnabled": true, + "NewMessage.WithMedia.Enabled": false, + "NewMessage.WithMedia.Template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}", + "AddedToConversation.Enabled": false, + "AddedToConversation.Template": "You have been added to a Conversation: ${CONVERSATION}", + "AddedToConversation.Sound": "ring", + "RemovedFromConversation.Enabled": false, + "RemovedFromConversation.Template": "You have been removed from a Conversation: ${CONVERSATION}", + "RemovedFromConversation.Sound": "ring", + "LogEnabled": true + } + } } } } @@ -8562,6 +11447,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_notification" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "log_enabled": false, + "added_to_conversation": { + "enabled": true, + "template": "You have been added to a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "new_message": { + "enabled": true, + "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}", + "badge_count_enabled": false, + "sound": "ring", + "with_media": { + "enabled": false, + "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}" + } + }, + "removed_from_conversation": { + "enabled": true, + "template": "You have been removed from a Conversation: ${CONVERSATION}", + "sound": "ring" + }, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications" + } + } } } }, @@ -8573,10 +11488,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceNotification" } }, "/v1/Services/{ChatServiceSid}/ParticipantConversations": { @@ -8592,8 +11504,8 @@ "participant_sid", "conversation_sid" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.", @@ -8616,6 +11528,14 @@ "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "identity" + }, + "readFullByIdentity": { + "value": "identity" + } } }, { @@ -8624,6 +11544,11 @@ "description": "A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.", "schema": { "type": "string" + }, + "examples": { + "readFullByAddress": { + "value": "+375255555555" + } } }, { @@ -8669,16 +11594,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8687,17 +11614,116 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByIdentity": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_identity": "identity", + "participant_messaging_binding": null, + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFullByAddress": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_friendly_name": "friendly_name", + "conversation_state": "inactive", + "conversation_timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "conversation_attributes": "{}", + "conversation_date_created": "2015-07-30T20:00:00Z", + "conversation_date_updated": "2015-07-30T20:00:00Z", + "conversation_created_by": "created_by", + "conversation_unique_name": "unique_name", + "participant_user_sid": null, + "participant_identity": null, + "participant_messaging_binding": { + "address": "+375255555555", + "proxy_address": "+12345678910", + "type": "sms", + "level": null, + "name": null, + "projected_address": null + }, + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -8712,10 +11738,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceParticipantConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceParticipantConversation" } }, "/v1/Services/{ChatServiceSid}/Roles": { @@ -8731,8 +11754,8 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new user role in your service", @@ -8756,6 +11779,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8768,9 +11811,6 @@ } ], "operationId": "CreateServiceRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8800,6 +11840,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Conversation Role", + "Type": "conversation", + "Permission": "sendMessage" + } + } } } } @@ -8863,16 +11912,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8881,18 +11932,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -8906,10 +12002,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceRole" } }, "/v1/Services/{ChatServiceSid}/Roles/{Sid}": { @@ -8925,8 +12018,8 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing user role in your service", @@ -8962,6 +12055,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8974,9 +12087,6 @@ } ], "operationId": "UpdateServiceRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8995,6 +12105,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -9038,10 +12155,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceRole" }, "get": { "description": "Fetch a user role from your service", @@ -9077,6 +12191,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Conversation Role", + "type": "conversation", + "permissions": [ + "sendMessage", + "leaveConversation", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -9088,10 +12222,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceRole" } }, "/v1/Services/{ChatServiceSid}/Users": { @@ -9106,11 +12237,11 @@ "sid", "identity" ], - "pathType": "list", "dependentProperties": { "user_conversation": "{chat_service_sid: chat_service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new conversation user to your service", @@ -9143,6 +12274,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -9155,9 +12307,6 @@ } ], "operationId": "CreateServiceUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9188,6 +12337,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "admin", + "FriendlyName": "name", + "Attributes": "{ \"duty\": \"tech\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -9251,16 +12410,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9269,18 +12430,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + }, + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "agent0034", + "friendly_name": "John from customs", + "attributes": "{ \"duty\": \"agent\" }", + "is_online": false, + "is_notifiable": null, + "date_created": "2020-03-24T20:38:21Z", + "date_updated": "2020-03-24T20:38:21Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + ] } } } @@ -9294,10 +12504,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceUser" } }, "/v1/Services/{ChatServiceSid}/Users/{Sid}": { @@ -9312,11 +12519,11 @@ "sid", "identity" ], - "pathType": "instance", "dependentProperties": { "user_conversation": "{chat_service_sid: chat_service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing conversation user in your service", @@ -9358,6 +12565,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "new name", + "attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -9370,9 +12598,6 @@ } ], "operationId": "UpdateServiceUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9396,6 +12621,15 @@ "description": "The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "new name", + "Attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -9445,10 +12679,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceUser" }, "get": { "description": "Fetch a conversation user from your service", @@ -9481,6 +12712,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -9492,10 +12744,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceUser" } }, "/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}": { @@ -9513,9 +12762,9 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Services/{ChatServiceSid}/Users/{Sid}", - "mountName": "user_conversations" + "mountName": "user_conversations", + "pathType": "instance" }, "post": { "description": "Update a specific User Conversation.", @@ -9557,6 +12806,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user.service_user_conversation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -9569,9 +12848,6 @@ } ], "operationId": "UpdateServiceUserConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9595,6 +12871,15 @@ "description": "The index of the last Message in the Conversation that the Participant has read." } } + }, + "examples": { + "update": { + "value": { + "NotificationLevel": "default", + "LastReadTimestamp": "2015-07-30T20:00:00Z", + "LastReadMessageIndex": 100 + } + } } } } @@ -9644,10 +12929,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceUserConversation" }, "get": { "description": "Fetch a specific User Conversation.", @@ -9689,6 +12971,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_user.service_user_conversation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -9700,10 +13012,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceUserConversation" } }, "/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations": { @@ -9721,9 +13030,9 @@ "friendly_name", "date_created" ], - "pathType": "list", "parent": "/Services/{ChatServiceSid}/Users/{Sid}", - "mountName": "user_conversations" + "mountName": "user_conversations", + "pathType": "list" }, "get": { "description": "Retrieve a list of all User Conversations for the User.", @@ -9792,16 +13101,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9810,17 +13121,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFull": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -9835,10 +13201,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceUserConversation" } }, "/v1/Services/{ChatServiceSid}/Configuration/Webhooks": { @@ -9852,8 +13215,8 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Configuration" + "parent": "/Services/{ChatServiceSid}/Configuration", + "pathType": "instance" }, "post": { "description": "Update a specific Webhook.", @@ -9877,6 +13240,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://www.example.com/pre", + "post_webhook_url": "https://www.example.com/post", + "filters": [ + "onMessageRemoved", + "onParticipantAdded" + ], + "method": "GET", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + } } } }, @@ -9889,9 +13268,6 @@ } ], "operationId": "UpdateServiceWebhookConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9921,6 +13297,19 @@ "description": "The HTTP method to be used when sending a webhook request. One of `GET` or `POST`." } } + }, + "examples": { + "update": { + "value": { + "PreWebhookUrl": "https://www.example.com/pre", + "PostWebhookUrl": "https://www.example.com/post", + "Filters": [ + "onMessageRemoved", + "onParticipantAdded" + ], + "Method": "GET" + } + } } } } @@ -9948,6 +13337,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "pre_webhook_url": "https://www.example.com/pre", + "post_webhook_url": "https://www.example.com/post", + "filters": [ + "onMessageRemove", + "onParticipantAdd" + ], + "method": "POST", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks" + } + }, + "fetchEmpty": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks", + "pre_webhook_url": null, + "post_webhook_url": null, + "filters": null, + "method": null + } + } } } }, @@ -9959,10 +13375,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceWebhookConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceWebhookConfiguration" } }, "/v1/Users": { @@ -9977,10 +13390,10 @@ "sid", "identity" ], - "pathType": "list", "dependentProperties": { "user_conversation": "{user_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Add a new conversation user to your account's default service", @@ -10001,6 +13414,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -10013,9 +13447,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10046,6 +13477,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "admin", + "FriendlyName": "name", + "Attributes": "{ \"duty\": \"tech\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -10097,16 +13538,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10115,18 +13558,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + }, + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "agent0034", + "friendly_name": "John from customs", + "attributes": "{ \"duty\": \"agent\" }", + "is_online": false, + "is_notifiable": null, + "date_created": "2020-03-24T20:38:21Z", + "date_updated": "2020-03-24T20:38:21Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + ] } } } @@ -10140,10 +13632,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Users/{Sid}": { @@ -10158,10 +13647,10 @@ "sid", "identity" ], - "pathType": "instance", "dependentProperties": { "user_conversation": "{user_sid: sid}" - } + }, + "pathType": "instance" }, "post": { "description": "Update an existing conversation user in your account's default service", @@ -10191,6 +13680,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "new name", + "attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -10203,9 +13713,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10229,6 +13736,15 @@ "description": "The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "new name", + "Attributes": "{ \"duty\": \"tech\", \"team\": \"internals\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -10266,10 +13782,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "get": { "description": "Fetch a conversation user from your account's default service", @@ -10290,6 +13803,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "admin", + "friendly_name": "name", + "attributes": "{ \"duty\": \"tech\" }", + "is_online": true, + "is_notifiable": null, + "date_created": "2019-12-16T22:18:37Z", + "date_updated": "2019-12-16T22:18:38Z", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user_conversations": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations" + } + } + } } } }, @@ -10301,10 +13835,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" } }, "/v1/Users/{UserSid}/Conversations/{ConversationSid}": { @@ -10322,9 +13853,9 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Users/{Sid}", - "mountName": "user_conversations" + "mountName": "user_conversations", + "pathType": "instance" }, "post": { "description": "Update a specific User Conversation.", @@ -10354,6 +13885,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user.user_conversation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -10366,9 +13927,6 @@ } ], "operationId": "UpdateUserConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10392,6 +13950,15 @@ "description": "The index of the last Message in the Conversation that the Participant has read." } } + }, + "examples": { + "update": { + "value": { + "NotificationLevel": "default", + "LastReadTimestamp": "2015-07-30T20:00:00Z", + "LastReadMessageIndex": 100 + } + } } } } @@ -10429,10 +13996,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserConversation" }, "get": { "description": "Fetch a specific User Conversation.", @@ -10462,6 +14026,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/conversations.v1.user.user_conversation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -10473,10 +14067,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserConversation" } }, "/v1/Users/{UserSid}/Conversations": { @@ -10494,9 +14085,9 @@ "friendly_name", "date_created" ], - "pathType": "list", "parent": "/Users/{Sid}", - "mountName": "user_conversations" + "mountName": "user_conversations", + "pathType": "list" }, "get": { "description": "Retrieve a list of all User Conversations for the User.", @@ -10553,16 +14144,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10571,17 +14164,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFull": { + "value": { + "conversations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unread_messages_count": 100, + "last_read_message_index": 100, + "participant_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "conversation_state": "inactive", + "timers": { + "date_inactive": "2015-12-16T22:19:38Z", + "date_closed": "2015-12-16T22:28:38Z" + }, + "attributes": "{}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "notification_level": "default", + "unique_name": "unique_name", + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participant": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -10596,10 +14244,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserConversation" } } }, @@ -10607,11 +14252,5 @@ { "url": "https://conversations.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index 9d361215..0d257887 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "events.v1.event_type": { "type": "object", @@ -299,12 +305,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -320,7 +320,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -337,8 +337,8 @@ "schema_id", "description" ], - "pathType": "list", - "mountName": "event_types" + "mountName": "event_types", + "pathType": "list" }, "get": { "description": "Retrieve a paginated list of all the available Event Types.", @@ -349,6 +349,11 @@ "description": "A string parameter filtering the results to return only the Event Types using a given schema.", "schema": { "type": "string" + }, + "examples": { + "readResultsWithSchemaId": { + "value": "Messaging.MessageStatus" + } } }, { @@ -394,16 +399,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -412,17 +419,109 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "types": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Types?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Types?PageSize=10&Page=0", + "next_page_url": null, + "key": "types" + } + } + }, + "readResults": { + "value": { + "types": [ + { + "date_created": "2020-08-13T13:28:20Z", + "date_updated": "2020-08-13T13:28:20Z", + "type": "com.twilio.messaging.message.delivered", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- delivered message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + }, + { + "date_created": "2020-08-13T13:28:19Z", + "date_updated": "2020-08-13T13:28:19Z", + "type": "com.twilio.messaging.message.failed", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- failed message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Types?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Types?PageSize=20&Page=0", + "next_page_url": null, + "key": "types" + } + } + }, + "readResultsWithSchemaId": { + "value": { + "types": [ + { + "date_created": "2020-08-13T13:28:20Z", + "date_updated": "2020-08-13T13:28:20Z", + "type": "com.twilio.messaging.message.delivered", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- delivered message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + }, + { + "date_created": "2020-08-13T13:28:19Z", + "date_updated": "2020-08-13T13:28:19Z", + "type": "com.twilio.messaging.message.failed", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- failed message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0", + "next_page_url": null, + "key": "types" } } } @@ -437,10 +536,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEventType", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEventType" } }, "/v1/Types/{Type}": { @@ -456,8 +552,8 @@ "schema_id", "description" ], - "pathType": "instance", - "mountName": "event_types" + "mountName": "event_types", + "pathType": "instance" }, "get": { "description": "Fetch a specific Event Type.", @@ -478,6 +574,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.event_type" + }, + "examples": { + "fetch": { + "value": { + "date_created": "2020-08-13T13:28:20Z", + "date_updated": "2020-08-13T13:28:20Z", + "type": "com.twilio.messaging.message.delivered", + "schema_id": "Messaging.MessageStatus", + "public": true, + "description": "Messaging- delivered message", + "url": "https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered", + "links": { + "schema": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + } } } }, @@ -489,10 +601,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEventType", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEventType" } }, "/v1/Schemas/{Id}": { @@ -506,10 +615,10 @@ "defaultOutputProperties": [ "id" ], - "pathType": "instance", "dependentProperties": { "schema_version": "{id: id}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific schema with its nested versions.", @@ -530,6 +639,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.schema" + }, + "examples": { + "fetch": { + "value": { + "id": "Messaging.MessageStatus", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus", + "latest_version_date_created": "2020-07-30T20:00:00Z", + "latest_version": 1, + "links": { + "versions": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions" + } + } + } } } }, @@ -541,10 +663,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSchema", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSchema" } }, "/v1/Schemas": { @@ -558,10 +677,10 @@ "defaultOutputProperties": [ "id" ], - "pathType": "list", "dependentProperties": { "schema_version": "{id: id}" - } + }, + "pathType": "list" } }, "/v1/Schemas/{Id}/Versions": { @@ -577,9 +696,9 @@ "schema_version", "date_created" ], - "pathType": "list", "parent": "/Schemas/{Id}", - "className": "schema_version" + "className": "schema_version", + "pathType": "list" }, "get": { "description": "Retrieve a paginated list of versions of the schema.", @@ -636,16 +755,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -654,17 +775,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "schema_versions": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0", + "next_page_url": null, + "key": "schema_versions" + } + } + }, + "readResults": { + "value": { + "schema_versions": [ + { + "id": "Messaging.MessageStatus", + "schema_version": 1, + "public": true, + "date_created": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1", + "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/1" + }, + { + "id": "Messaging.MessageStatus", + "schema_version": 2, + "public": true, + "date_created": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/2", + "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/2" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0", + "next_page_url": null, + "key": "schema_versions" } } } @@ -679,10 +845,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSchemaVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSchemaVersion" } }, "/v1/Schemas/{Id}/Versions/{SchemaVersion}": { @@ -698,9 +861,9 @@ "schema_version", "date_created" ], - "pathType": "instance", "parent": "/Schemas/{Id}", - "className": "schema_version" + "className": "schema_version", + "pathType": "instance" }, "get": { "description": "Fetch a specific schema and version.", @@ -730,6 +893,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.schema.schema_version" + }, + "examples": { + "fetch": { + "value": { + "id": "Messaging.MessageStatus", + "schema_version": 1, + "public": true, + "date_created": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1", + "raw": "https://events-schemas.twilio.com/Messaging.MessageStatus/1" + } + } } } }, @@ -741,10 +916,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSchemaVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSchemaVersion" } }, "/v1/Sinks/{Sid}": { @@ -764,11 +936,11 @@ "sink_type", "status" ], - "pathType": "instance", "dependentProperties": { "sink_test": "{sid: sid}", "sink_validate": "{sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Sink.", @@ -792,6 +964,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink" + }, + "examples": { + "fetch": { + "value": { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "A Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + } } } }, @@ -803,10 +997,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSink", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSink" }, "delete": { "description": "Delete a specific Sink.", @@ -834,10 +1025,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSink", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSink" }, "post": { "description": "Update a specific Sink", @@ -861,6 +1049,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink" + }, + "examples": { + "update": { + "value": { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "My Kinesis Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + } } } }, @@ -873,9 +1083,6 @@ } ], "operationId": "UpdateSink", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -891,6 +1098,13 @@ "required": [ "Description" ] + }, + "examples": { + "update": { + "value": { + "Description": "My Kinesis Sink" + } + } } } } @@ -914,11 +1128,11 @@ "sink_type", "status" ], - "pathType": "list", "dependentProperties": { "sink_test": "{sid: sid}", "sink_validate": "{sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new Sink", @@ -928,6 +1142,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink" + }, + "examples": { + "create": { + "value": { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "My Kinesis Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + }, + "createSegment": { + "value": { + "status": "initialized", + "sink_configuration": { + "write_key": "MY_WRITEKEY" + }, + "description": "My segment Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "segment", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + } + } } } }, @@ -940,9 +1194,6 @@ } ], "operationId": "CreateSink", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -968,6 +1219,22 @@ "SinkConfiguration", "SinkType" ] + }, + "examples": { + "create": { + "value": { + "Description": "My Kinesis Sink", + "SinkType": "kinesis", + "SinkConfiguration": "{\"arn\": \"arn:aws:kinesis:us-east-1:111111111:stream/test\",\"role_arn\": \"arn:aws:iam::111111111:role/Role\",\"external_id\": \"1234567890\"}" + } + }, + "createSegment": { + "value": { + "Description": "My segment Sink", + "SinkType": "segment", + "SinkConfiguration": "{\"write_key\": \"MY_WRITEKEY\"}" + } + } } } } @@ -982,6 +1249,11 @@ "description": "A boolean query parameter filtering the results to return sinks used/not used by a subscription.", "schema": { "type": "boolean" + }, + "examples": { + "readResultsInUse": { + "value": true + } } }, { @@ -990,6 +1262,11 @@ "description": "A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.", "schema": { "type": "string" + }, + "examples": { + "readResultsStatus": { + "value": "active" + } } }, { @@ -1035,16 +1312,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1053,17 +1332,202 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sinks": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Sinks?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?PageSize=10&Page=0", + "next_page_url": null, + "key": "sinks" + } + } + }, + "readResults": { + "value": { + "sinks": [ + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "A Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T19:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + }, + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:222222222:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "ANOTHER Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate" + } + }, + { + "status": "active", + "sink_configuration": { + "destination": "http://example.org/webhook", + "method": "POST", + "batch_events": true + }, + "description": "A webhook Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "date_created": "2015-07-30T21:00:00Z", + "sink_type": "webhook", + "date_updated": "2015-07-30T21:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Sinks?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?PageSize=20&Page=0", + "next_page_url": null, + "key": "sinks" + } + } + }, + "readResultsInUse": { + "value": { + "sinks": [ + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "A Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T19:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate" + } + }, + { + "status": "initialized", + "sink_configuration": { + "arn": "arn:aws:kinesis:us-east-1:222222222:stream/test", + "role_arn": "arn:aws:iam::111111111:role/Role", + "external_id": "1234567890" + }, + "description": "ANOTHER Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2015-07-30T20:00:00Z", + "sink_type": "kinesis", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate" + } + }, + { + "status": "active", + "sink_configuration": { + "destination": "http://example.org/webhook", + "method": "POST", + "batch_events": true + }, + "description": "A webhook Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "date_created": "2015-07-30T21:00:00Z", + "sink_type": "webhook", + "date_updated": "2015-07-30T21:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0", + "next_page_url": null, + "key": "sinks" + } + } + }, + "readResultsStatus": { + "value": { + "sinks": [ + { + "status": "active", + "sink_configuration": { + "destination": "http://example.org/webhook", + "method": "POST", + "batch_events": true + }, + "description": "A webhook Sink", + "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "date_created": "2015-07-30T21:00:00Z", + "sink_type": "webhook", + "date_updated": "2015-07-30T21:00:00Z", + "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "links": { + "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test", + "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0", + "next_page_url": null, + "key": "sinks" } } } @@ -1078,10 +1542,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSink", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSink" } }, "/v1/Sinks/{Sid}/Test": { @@ -1095,9 +1556,9 @@ "defaultOutputProperties": [ "result" ], - "pathType": "list", "parent": "/Sinks/{Sid}", - "mountName": "sink_test" + "mountName": "sink_test", + "pathType": "list" }, "post": { "description": "Create a new Sink Test Event for the given Sink.", @@ -1121,6 +1582,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink.sink_test" + }, + "examples": { + "create": { + "value": { + "result": "submitted" + } + } } } }, @@ -1132,10 +1600,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSinkTest", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateSinkTest" } }, "/v1/Sinks/{Sid}/Validate": { @@ -1149,9 +1614,9 @@ "defaultOutputProperties": [ "result" ], - "pathType": "list", "parent": "/Sinks/{Sid}", - "mountName": "sink_validate" + "mountName": "sink_validate", + "pathType": "list" }, "post": { "description": "Validate that a test event for a Sink was received.", @@ -1175,6 +1640,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink.sink_validate" + }, + "examples": { + "create": { + "value": { + "result": "valid" + } + } } } }, @@ -1187,9 +1659,6 @@ } ], "operationId": "CreateSinkValidate", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1205,6 +1674,13 @@ "required": [ "TestId" ] + }, + "examples": { + "create": { + "value": { + "TestId": "TestID" + } + } } } } @@ -1225,8 +1701,8 @@ "account_sid", "subscription_sid" ], - "pathType": "list", - "parent": "/Subscriptions/{Sid}" + "parent": "/Subscriptions/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Subscribed Event types for a Subscription.", @@ -1286,16 +1762,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1304,17 +1782,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "types": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0", + "next_page_url": null, + "key": "types" + } + } + }, + "readResults": { + "value": { + "types": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.failed", + "schema_version": 15, + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.failed" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0", + "next_page_url": null, + "key": "types" } } } @@ -1329,10 +1850,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSubscribedEvent", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSubscribedEvent" }, "post": { "description": "Create a new Subscribed Event type for the subscription", @@ -1356,6 +1874,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription.subscribed_event" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + } + } } } }, @@ -1368,9 +1897,6 @@ } ], "operationId": "CreateSubscribedEvent", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1390,6 +1916,14 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "com.twilio.messaging.message.delivered", + "SchemaVersion": 2 + } + } } } } @@ -1410,8 +1944,8 @@ "account_sid", "subscription_sid" ], - "pathType": "instance", - "parent": "/Subscriptions/{Sid}" + "parent": "/Subscriptions/{Sid}", + "pathType": "instance" }, "get": { "description": "Read an Event for a Subscription.", @@ -1444,6 +1978,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription.subscribed_event" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + } + } } } }, @@ -1455,10 +2000,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSubscribedEvent", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSubscribedEvent" }, "post": { "description": "Update an Event for a Subscription.", @@ -1491,6 +2033,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription.subscribed_event" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "subscription_sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "com.twilio.messaging.message.delivered", + "schema_version": 2, + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered" + } + } } } }, @@ -1503,9 +2056,6 @@ } ], "operationId": "UpdateSubscribedEvent", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1518,6 +2068,13 @@ "description": "The schema version that the subscription should use." } } + }, + "examples": { + "update": { + "value": { + "SchemaVersion": 2 + } + } } } } @@ -1558,10 +2115,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSubscribedEvent", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSubscribedEvent" } }, "/v1/Subscriptions": { @@ -1579,10 +2133,10 @@ "date_created", "date_updated" ], - "pathType": "list", "dependentProperties": { "subscribed_event": "{subscription_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a paginated list of Subscriptions belonging to the account used to make the request.", @@ -1596,6 +2150,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^DG[0-9a-fA-F]{32}$" + }, + "examples": { + "readResultsFilteredBySinkSid": { + "value": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1641,16 +2200,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1659,17 +2220,109 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "subscriptions": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0", + "next_page_url": null, + "key": "subscriptions" + } + } + }, + "readResults": { + "value": { + "subscriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Another subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0", + "next_page_url": null, + "key": "subscriptions" + } + } + }, + "readResultsFilteredBySinkSid": { + "value": { + "subscriptions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Another subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents" + } + } + ], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0", + "next_page_url": null, + "key": "subscriptions" } } } @@ -1684,19 +2337,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListSubscription", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSubscription" }, "post": { "description": "Create a new Subscription.", + "parameters": [], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + } + } } } }, @@ -1709,9 +2376,6 @@ } ], "operationId": "CreateSubscription", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1741,6 +2405,18 @@ "SinkSid", "Types" ] + }, + "examples": { + "create": { + "value": { + "SinkSid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Description": "A subscription", + "Types": [ + "{\"type\": \"com.twilio.messaging.message.delivered\",\"schema_version\": 1}", + "{\"type\": \"com.twilio.messaging.message.failed\",\"schema_version\": 12}" + ] + } + } } } } @@ -1762,10 +2438,10 @@ "date_created", "date_updated" ], - "pathType": "instance", "dependentProperties": { "subscribed_event": "{subscription_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Subscription.", @@ -1789,6 +2465,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "A subscription", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + } + } } } }, @@ -1800,10 +2492,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSubscription", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSubscription" }, "post": { "description": "Update a Subscription.", @@ -1827,6 +2516,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.subscription" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2020-07-30T20:01:33Z", + "sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "description": "Updated description", + "url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents" + } + } + } } } }, @@ -1839,9 +2544,6 @@ } ], "operationId": "UpdateSubscription", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1861,6 +2563,14 @@ "description": "The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created." } } + }, + "examples": { + "update": { + "value": { + "SinkSid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "Description": "Updated description" + } + } } } } @@ -1892,10 +2602,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSubscription", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSubscription" } } }, @@ -1903,11 +2610,5 @@ { "url": "https://events.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 90ccb85d..077fc5fa 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "flex.v1.channel": { "type": "object", @@ -1233,12 +1239,6 @@ "inactive" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1254,7 +1254,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1272,8 +1272,8 @@ "user_sid", "task_sid" ], - "pathType": "list", - "mountName": "channel" + "mountName": "channel", + "pathType": "list" }, "get": { "description": "", @@ -1321,16 +1321,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1339,18 +1341,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [ + { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [] } } } @@ -1364,10 +1405,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" }, "post": { "description": "", @@ -1377,6 +1415,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.channel" + }, + "examples": { + "create": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1389,9 +1441,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1452,6 +1501,22 @@ "ChatUserFriendlyName", "ChatFriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FlexFlowSid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Target": "def", + "Identity": "abc", + "ChatUserFriendlyName": "friendly2", + "ChatFriendlyName": "friendly1", + "ChatUniqueName": "unique", + "PreEngagementData": "{}", + "TaskSid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskAttributes": "{}", + "LongLived": true + } + } } } } @@ -1472,8 +1537,8 @@ "user_sid", "task_sid" ], - "pathType": "instance", - "mountName": "channel" + "mountName": "channel", + "pathType": "instance" }, "get": { "description": "", @@ -1497,6 +1562,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.channel" + }, + "examples": { + "fetch": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1508,10 +1587,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -1539,10 +1615,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" } }, "/v1/Configuration": { @@ -1579,6 +1652,234 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "attributes": { + "main_attribute": "some_attribute" + }, + "status": "ok", + "taskrouter_workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "taskrouter_target_workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "taskrouter_target_taskqueue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "taskrouter_taskqueues": [ + { + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "targettable": true + }, + { + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "targettable": false + } + ], + "taskrouter_skills": [ + { + "name": "sales", + "multivalue": false, + "minimum": 0, + "maximum": 0 + }, + { + "name": "support", + "multivalue": true, + "minimum": 0, + "maximum": 10 + } + ], + "taskrouter_worker_channels": { + "agent": [ + { + "name": "default", + "availability": true, + "capacity": 1 + }, + { + "name": "voice", + "availability": false, + "capacity": 2 + } + ], + "supervisor": [ + { + "name": "default", + "availability": true, + "capacity": 2 + } + ] + }, + "taskrouter_worker_attributes": { + "agent": { + "region": "us-east" + }, + "supervisor": { + "region": "us" + } + }, + "taskrouter_offline_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "runtime_domain": "https://flex.twilio.com", + "messaging_service_instance_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ui_language": "en", + "ui_attributes": {}, + "ui_dependencies": {}, + "ui_version": "1.0", + "service_version": "1.0", + "call_recording_enabled": true, + "call_recording_webhook_url": "https://www.example.com/call-recording", + "crm_enabled": true, + "crm_type": "custom", + "crm_callback_url": "https://crm.com/a", + "crm_fallback_url": "https://crm.com/b", + "crm_attributes": { + "crm_attribute": "some_crm" + }, + "public_attributes": { + "public": "test" + }, + "plugin_service_enabled": true, + "plugin_service_attributes": { + "agent-logger": "^3.10.5", + "typewriter": "^7.0.1" + }, + "integrations": [ + { + "name": "twilio", + "type": "http", + "active": true, + "config": "{\"callback\":\"twilio.com/cb\",\"allowed_methods\":[\"GET\",\"POST\"]}", + "logo": "logo1", + "author": "somebody1" + }, + { + "name": "twilio-stage", + "type": "http", + "active": false, + "config": "{\"callback\":\"twilio.com/cb\",\"allowed_methods\":[\"GET\",\"POST\"]}" + } + ], + "outbound_call_flows": { + "default": { + "caller_id": "+12345", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "EE", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "queue_stats_configuration": { + "default": { + "service_level_threshold": 20, + "short_abandoned_threshold": 5, + "reset_timezone": "America/New_York", + "reset_time": "00:00" + }, + "queue_configurations": [ + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reset_timezone": "Europe/Tallinn", + "reset_time": "01:00" + }, + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "reset_timezone": "Europe/Paris", + "reset_time": "02:00" + } + ], + "queue_channel_configurations": [ + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_level_threshold": 10, + "short_abandoned_threshold": 10 + }, + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "service_level_threshold": 30, + "short_abandoned_threshold": 15 + } + ] + }, + "serverless_service_sids": [ + "ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "notifications": { + "enabled": true, + "mode": "whenNotInFocus" + }, + "markdown": { + "enabled": false, + "mode": "readOnly" + }, + "flex_insights_hr": { + "advanced_reporting_enabled": true, + "advanced_reporting_workspaces": [ + { + "id": "ID_1", + "timezone": "America/Los_Angeles", + "workspace_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "id": "ID_2", + "timezone": "Etc/UTC" + } + ] + }, + "url": "https://flex-api.twilio.com/v1/Configuration", + "flex_insights_drilldown": true, + "flex_url": "https://flex.twilio.com", + "channel_configs": [ + { + "address_type": "sms", + "cbm_attachments": { + "enabled": true, + "number_of_attachments": 10, + "max_file_size": 157286400, + "max_total_file_size": 157286400, + "accepted_extensions": [ + "jpg", + "jpeg", + "png", + "gif", + "txt", + "pdf" + ] + } + }, + { + "address_type": "whatsapp", + "cbm_attachments": { + "enabled": true, + "number_of_attachments": 1, + "max_file_size": 16777216, + "max_total_file_size": 67108864, + "accepted_extensions": [ + "jpg", + "jpeg", + "png", + "amr", + "mp3", + "mp4", + "pdf", + "heic", + "oga" + ] + } + } + ], + "debugger_integration": { + "enabled": false + }, + "flex_ui_status_report": { + "enabled": false + } + } + } } } }, @@ -1590,10 +1891,236 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfiguration" + }, + "post": { + "description": "", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "attributes": { + "main_attribute": "some_attribute" + }, + "status": "ok", + "taskrouter_workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "taskrouter_target_workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "taskrouter_target_taskqueue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "taskrouter_taskqueues": [ + { + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "targettable": true + }, + { + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac", + "targettable": false + } + ], + "taskrouter_skills": [ + { + "name": "sales", + "multivalue": false, + "minimum": 0, + "maximum": 0 + }, + { + "name": "support", + "multivalue": true, + "minimum": 0, + "maximum": 10 + } + ], + "taskrouter_worker_channels": { + "agent": [ + { + "name": "default", + "availability": true, + "capacity": 1 + }, + { + "name": "voice", + "availability": false, + "capacity": 2 + } + ], + "supervisor": [ + { + "name": "default", + "availability": true, + "capacity": 2 + } + ] + }, + "taskrouter_worker_attributes": { + "agent": { + "region": "us-east" + }, + "supervisor": { + "region": "us" + } + }, + "taskrouter_offline_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "runtime_domain": "https://flex.twilio.com", + "messaging_service_instance_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ui_language": "en", + "ui_attributes": {}, + "ui_dependencies": {}, + "ui_version": "1.0", + "service_version": "1.0", + "call_recording_enabled": true, + "call_recording_webhook_url": "https://www.example.com/call-recording", + "crm_enabled": true, + "crm_type": "custom", + "crm_callback_url": "https://crm.com/a", + "crm_fallback_url": "https://crm.com/b", + "crm_attributes": { + "crm_attribute": "some_crm" + }, + "public_attributes": { + "public": "test" + }, + "plugin_service_enabled": false, + "plugin_service_attributes": { + "agent-logger": "^3.10.5", + "typewriter": "^7.0.1" + }, + "integrations": [ + { + "name": "twilio", + "type": "http", + "active": true, + "config": "{\"callback\":\"twilio.com/cb\",\"allowed_methods\":[\"GET\",\"POST\"]}", + "logo": "logo1", + "author": "somebody1" + }, + { + "name": "twilio-stage", + "type": "http", + "active": false, + "config": "{\"callback\":\"twilio.com/cb\",\"allowed_methods\":[\"GET\",\"POST\"]}" + } + ], + "outbound_call_flows": { + "default": { + "caller_id": "+12345", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "EE", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "queue_stats_configuration": { + "default": { + "service_level_threshold": 20, + "short_abandoned_threshold": 5, + "reset_timezone": "America/New_York", + "reset_time": "00:00" + }, + "queue_configurations": [ + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reset_timezone": "Europe/Tallinn", + "reset_time": "01:00" + }, + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "reset_timezone": "Europe/Paris", + "reset_time": "02:00" + } + ], + "queue_channel_configurations": [ + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_level_threshold": 10, + "short_abandoned_threshold": 10 + }, + { + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "service_level_threshold": 30, + "short_abandoned_threshold": 15 + } + ] + }, + "serverless_service_sids": [ + "ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "notifications": { + "enabled": true, + "mode": "whenNotInFocus" + }, + "markdown": { + "enabled": false, + "mode": "readOnly" + }, + "flex_insights_hr": { + "advanced_reporting_enabled": true, + "advanced_reporting_workspaces": [ + { + "id": "ID_1", + "timezone": "America/Los_Angeles", + "workspace_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "id": "ID_2", + "timezone": "Etc/UTC" + } + ] + }, + "url": "https://flex-api.twilio.com/v1/Configuration", + "flex_insights_drilldown": true, + "flex_url": "https://flex.twilio.com", + "channel_configs": [ + { + "address_type": "sms", + "cbm_attachments": { + "enabled": true, + "number_of_attachments": 10, + "max_file_size": 157286400, + "max_total_file_size": 157286400, + "accepted_extensions": [ + "jpg", + "jpeg", + "png", + "gif", + "txt", + "pdf" + ] + } + } + ], + "debugger_integration": { + "enabled": false + }, + "flex_ui_status_report": { + "enabled": false + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateConfiguration" } }, "/v1/FlexFlows": { @@ -1610,8 +2137,8 @@ "channel_type", "integration_type" ], - "pathType": "list", - "mountName": "flex_flow" + "mountName": "flex_flow", + "pathType": "list" }, "get": { "description": "", @@ -1667,16 +2194,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1685,18 +2214,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_flows" + }, + "flex_flows": [ + { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_flows" + }, + "flex_flows": [] } } } @@ -1710,10 +2287,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlexFlow" }, "post": { "description": "", @@ -1723,6 +2297,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.flex_flow" + }, + "examples": { + "create": { + "value": { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1735,9 +2332,6 @@ } ], "operationId": "CreateFlexFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1834,6 +2428,22 @@ "ChatServiceSid", "ChannelType" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "ChatServiceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelType": "sms", + "ContactIdentity": "12345", + "Enabled": true, + "IntegrationType": "studio", + "Integration.FlowSid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "LongLived": true, + "JanitorEnabled": true, + "Integration.RetryCount": 1 + } + } } } } @@ -1854,8 +2464,8 @@ "channel_type", "integration_type" ], - "pathType": "instance", - "mountName": "flex_flow" + "mountName": "flex_flow", + "pathType": "instance" }, "get": { "description": "", @@ -1879,6 +2489,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.flex_flow" + }, + "examples": { + "fetch": { + "value": { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1890,10 +2523,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlexFlow" }, "post": { "description": "", @@ -1917,6 +2547,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.flex_flow" + }, + "examples": { + "update": { + "value": { + "sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "friendly_name": "friendly_name", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_type": "sms", + "contact_identity": "12345", + "enabled": true, + "integration_type": "studio", + "integration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "retry_count": 1 + }, + "long_lived": true, + "janitor_enabled": true, + "url": "https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1929,9 +2582,6 @@ } ], "operationId": "UpdateFlexFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2023,6 +2673,22 @@ "description": "The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "ChatServiceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelType": "sms", + "ContactIdentity": "12345", + "Enabled": true, + "IntegrationType": "studio", + "Integration.FlowSid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "LongLived": true, + "JanitorEnabled": true, + "Integration.RetryCount": 1 + } + } } } } @@ -2054,10 +2720,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlexFlow" } }, "/v1/Insights/QualityManagement/Assessments": { @@ -2066,15 +2729,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "assessment_sid", "assessment" ], - "pathType": "list", - "className": "assessments" + "className": "assessments", + "pathType": "list" }, "post": { "description": "Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.", @@ -2094,6 +2757,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_assessments" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "user_name": "Supervisor", + "user_email": "supervisor@example.com", + "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "answer_text": "Fair", + "timestamp": "1657329694199", + "assessment": { + "questionnaire": { + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Customer Experience", + "question": { + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Active listening", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Good for Training" + } + } + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2106,9 +2802,6 @@ } ], "operationId": "CreateInsightsAssessments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2178,6 +2871,22 @@ "AnswerId", "QuestionnaireSid" ] + }, + "examples": { + "create": { + "value": { + "CategorySid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CategoryName": "Good for Training", + "SegmentId": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "AgentId": "583fcaa6-a4ef-5447-9077-900421e37a61", + "Offset": "6.985619", + "MetricId": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MetricName": "Active listening", + "AnswerId": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "AnswerText": "Fair", + "QuestionnaireSid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2200,6 +2909,14 @@ "description": "The id of the segment.", "schema": { "type": "string" + }, + "examples": { + "readBySegmentId": { + "value": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc" + }, + "readEmpty": { + "value": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc" + } } }, { @@ -2245,16 +2962,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2263,17 +2982,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readBySegmentId": { + "value": { + "assessments": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "user_name": "Supervisor", + "user_email": "supervisor@example.com", + "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "answer_text": "Fair", + "timestamp": "1657329694199", + "assessment": { + "questionnaire": { + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Customer Experience", + "question": { + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Active listening", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Good for Training" + } + } + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0", + "key": "assessments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "assessments": [], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0", + "key": "assessments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0" } } } @@ -2288,10 +3065,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessments", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsAssessments" } }, "/v1/Insights/QualityManagement/Assessments/{AssessmentSid}": { @@ -2300,15 +3074,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "assessment_sid", "assessment" ], - "pathType": "instance", - "className": "assessments" + "className": "assessments", + "pathType": "instance" }, "post": { "description": "Update a specific Assessment assessed earlier", @@ -2340,6 +3114,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_assessments" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7", + "user_name": "Supervisor", + "user_email": "supervisor@example.com", + "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "answer_text": "Fair", + "timestamp": "1657329694199", + "assessment": { + "questionnaire": { + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Customer Experience", + "question": { + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Active listening", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Good for Training" + } + } + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2352,9 +3159,6 @@ } ], "operationId": "UpdateInsightsAssessments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2380,6 +3184,15 @@ "AnswerText", "AnswerId" ] + }, + "examples": { + "update": { + "value": { + "Offset": "6.985619", + "AnswerId": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "AnswerText": "Fair" + } + } } } } @@ -2392,15 +3205,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "assessment_sid", "comment" ], - "pathType": "list", - "mountName": "insights_assessments_comment" + "mountName": "insights_assessments_comment", + "pathType": "list" }, "post": { "description": "To create a comment assessment for a conversation", @@ -2420,6 +3233,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7", + "user_name": "Linda Houghton", + "user_email": "linda.houghton@vacasa.com", + "timestamp": "1657329694199", + "comment": { + "comment": "log0zu0268", + "category": { + "category_id": "c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e", + "name": "Good for Training" + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2432,9 +3269,6 @@ } ], "operationId": "CreateInsightsAssessmentsComment", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2475,6 +3309,18 @@ "AgentId", "Offset" ] + }, + "examples": { + "create": { + "value": { + "CategoryId": "4b4e78e4-4f05-49e2-bf52-0973c5cde418", + "CategoryName": "Good for Training", + "Comment": "log0zu0268", + "SegmentId": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc", + "AgentId": "583fcaa6-a4ef-5447-9077-900421e37a61", + "Offset": "6.985619" + } + } } } } @@ -2497,6 +3343,14 @@ "description": "The id of the segment.", "schema": { "type": "string" + }, + "examples": { + "readBySegmentId": { + "value": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7" + }, + "readEmpty": { + "value": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7" + } } }, { @@ -2505,6 +3359,11 @@ "description": "The id of the agent.", "schema": { "type": "string" + }, + "examples": { + "readByAgentId": { + "value": "5d80ee80-7608-55df-b2b2-5ab5608b9831" + } } }, { @@ -2550,16 +3409,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2568,17 +3429,101 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readBySegmentId": { + "value": { + "comments": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7", + "user_name": "Linda Houghton", + "user_email": "linda.houghton@vacasa.com", + "timestamp": "1657329694199", + "comment": { + "comment": "log0zu0268", + "category": { + "category_id": "c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e", + "name": "Good for Training" + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0", + "key": "comments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0" + } + } + }, + "readByAgentId": { + "value": { + "comments": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offset": "0.0", + "report": true, + "weight": "1", + "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831", + "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7", + "user_name": "Linda Houghton", + "user_email": "linda.houghton@vacasa.com", + "timestamp": "1657329694199", + "comment": { + "comment": "log0zu0268", + "category": { + "category_id": "c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e", + "name": "Good for Training" + } + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0", + "key": "comments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "comments": [], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0", + "key": "comments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0" } } } @@ -2593,10 +3538,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessmentsComment", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsAssessmentsComment" } }, "/v1/Insights/Conversations": { @@ -2605,7 +3547,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conversation_id", @@ -2613,9 +3555,9 @@ "segment_count", "segments" ], - "pathType": "list", "mountName": "insights_conversations", - "className": "insights_conversations" + "className": "insights_conversations", + "pathType": "list" }, "get": { "description": "To get conversation with segment id", @@ -2634,6 +3576,14 @@ "description": "Unique Id of the segment for which conversation details needs to be fetched", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a4" + }, + "readFull": { + "value": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a4" + } } }, { @@ -2679,16 +3629,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2697,17 +3649,69 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "conversations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" + } + } + }, + "readFull": { + "value": { + "conversations": [ + { + "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d", + "conversation_id": "2cb2452a-c6d9-564d-b285-b5404f073031", + "segment_count": 2, + "segments": [ + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a4", + "order": 0, + "offset": 1.542, + "talk_time": 18, + "timestamp": "2022-05-11T16:02:27.659Z", + "agent_name": "First Agent" + }, + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5", + "order": 0, + "offset": 1.211, + "talk_time": 10, + "timestamp": "2022-05-21T16:02:27.659Z", + "agent_name": "Second Agent" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0", + "next_page_url": null, + "key": "conversations" } } } @@ -2722,10 +3726,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsConversations", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsConversations" } }, "/v1/Insights/QualityManagement/Questionnaires": { @@ -2734,16 +3735,16 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "questionnaire_sid", "name" ], - "pathType": "list", "mountName": "insights_questionnaires", - "className": "insights_questionnaires" + "className": "insights_questionnaires", + "pathType": "list" }, "post": { "description": "To create a Questionnaire", @@ -2763,6 +3764,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "abc", + "description": "description", + "active": false, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2775,9 +3814,6 @@ } ], "operationId": "CreateInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2811,6 +3847,19 @@ "required": [ "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "abc", + "Description": "description", + "Active": false, + "QuestionSids": [ + "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } + } } } } @@ -2833,6 +3882,14 @@ "description": "Flag indicating whether to include inactive questionnaires or not", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + }, + "readFull": { + "value": true + } } }, { @@ -2878,16 +3935,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2896,17 +3955,163 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "questionnaires": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0", + "next_page_url": null, + "key": "questionnaires" + } + } + }, + "readFull": { + "value": { + "questionnaires": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "abc", + "description": "description", + "active": false, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "abc", + "description": "description", + "active": true, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0", + "key": "questionnaires", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0" + } + } + }, + "readActiveQuestionnaires": { + "value": { + "questionnaires": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "efg", + "description": "description", + "active": true, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0", + "key": "questionnaires", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0" } } } @@ -2921,10 +4126,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnaires" } }, "/v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}": { @@ -2933,16 +4135,16 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "questionnaire_sid", "name" ], - "pathType": "instance", "mountName": "insights_questionnaires", - "className": "insights_questionnaires" + "className": "insights_questionnaires", + "pathType": "instance" }, "post": { "description": "To update the questionnaire", @@ -2974,6 +4176,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "abc", + "description": "description", + "active": true, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2986,9 +4226,6 @@ } ], "operationId": "UpdateInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3022,6 +4259,19 @@ "required": [ "Active" ] + }, + "examples": { + "update": { + "value": { + "Name": "abc", + "Description": "description", + "Active": true, + "QuestionSids": [ + "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } + } } } } @@ -3061,10 +4311,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteInsightsQuestionnaires" }, "get": { "description": "To get the Questionnaire Detail", @@ -3096,6 +4343,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "efg", + "description": "description", + "active": true, + "questions": [ + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + }, + { + "question": "What is the total time", + "description": "time spent", + "category": { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_name": "test cat" + }, + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3107,10 +4392,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsQuestionnaires" } }, "/v1/Insights/QualityManagement/Categories": { @@ -3119,15 +4401,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "category_sid", "name" ], - "pathType": "list", - "mountName": "insights_questionnaires_category" + "mountName": "insights_questionnaires_category", + "pathType": "list" }, "post": { "description": "To create a category for Questions", @@ -3147,6 +4429,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "abc", + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3159,9 +4451,6 @@ } ], "operationId": "CreateInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3177,6 +4466,13 @@ "required": [ "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "abc" + } + } } } } @@ -3236,16 +4532,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3254,17 +4552,52 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "categories": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "next_page_url": null, + "key": "categories" + } + } + }, + "readFull": { + "value": { + "categories": [ + { + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "Test1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0", + "next_page_url": null, + "key": "categories" } } } @@ -3279,10 +4612,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnairesCategory" } }, "/v1/Insights/QualityManagement/Categories/{CategorySid}": { @@ -3291,15 +4621,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "category_sid", "name" ], - "pathType": "instance", - "mountName": "insights_questionnaires_category" + "mountName": "insights_questionnaires_category", + "pathType": "instance" }, "post": { "description": "To update the category for Questions", @@ -3331,6 +4661,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "abcd", + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3343,9 +4683,6 @@ } ], "operationId": "UpdateInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3361,6 +4698,13 @@ "required": [ "Name" ] + }, + "examples": { + "update": { + "value": { + "Name": "abcd" + } + } } } } @@ -3400,10 +4744,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteInsightsQuestionnairesCategory" } }, "/v1/Insights/QualityManagement/Questions": { @@ -3412,15 +4753,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "question_sid", "question" ], - "pathType": "list", - "mountName": "insights_questionnaires_question" + "mountName": "insights_questionnaires_question", + "pathType": "list" }, "post": { "description": "To create a question for a Category", @@ -3440,6 +4781,47 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "question": "What is the total time", + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "time spent", + "category": { + "category_name": "test cat", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0, + "answer_set": { + "sort": 0, + "name": "Yes, No", + "answers": [ + { + "sort": 0, + "score": 100, + "description": "Yes.", + "name": "Yes", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3" + }, + { + "sort": 1, + "score": 0, + "description": "No or a very poor.", + "name": "No", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c" + } + ], + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "type": "select", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58" + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3452,9 +4834,6 @@ } ], "operationId": "CreateInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3492,6 +4871,17 @@ "AnswerSetId", "AllowNa" ] + }, + "examples": { + "create": { + "value": { + "CategorySid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Question": "What is the total time", + "Description": "time spent", + "AnswerSetId": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "AllowNa": false + } + } } } } @@ -3520,6 +4910,20 @@ "maxLength": 34, "pattern": "^FY[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + }, + "readFull": { + "value": [ + "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } } }, { @@ -3565,16 +4969,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3583,17 +4989,83 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "questions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "questions" + } + } + }, + "readFull": { + "value": { + "questions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "question": "What is the total time", + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "time spent", + "category": { + "category_name": "test cat", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0, + "answer_set": { + "sort": 0, + "name": "Yes, No", + "answers": [ + { + "sort": 0, + "score": 100, + "description": "Yes.", + "name": "Yes", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3" + }, + { + "sort": 1, + "score": 0, + "description": "No or a very poor.", + "name": "No", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c" + } + ], + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "type": "select", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58" + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "questions" } } } @@ -3608,10 +5080,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnairesQuestion" } }, "/v1/Insights/QualityManagement/Questions/{QuestionSid}": { @@ -3620,15 +5089,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "question_sid", "question" ], - "pathType": "instance", - "mountName": "insights_questionnaires_question" + "mountName": "insights_questionnaires_question", + "pathType": "instance" }, "post": { "description": "To update the question", @@ -3660,6 +5129,47 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "question": "What is the total time", + "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "time spent", + "category": { + "category_name": "test cat", + "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "answer_set_id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "allow_na": false, + "usage": 0, + "answer_set": { + "sort": 0, + "name": "Yes, No", + "answers": [ + { + "sort": 0, + "score": 100, + "description": "Yes.", + "name": "Yes", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3" + }, + { + "sort": 1, + "score": 0, + "description": "No or a very poor.", + "name": "No", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c" + } + ], + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "type": "select", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58" + }, + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3672,9 +5182,6 @@ } ], "operationId": "UpdateInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3709,6 +5216,16 @@ "required": [ "AllowNa" ] + }, + "examples": { + "update": { + "value": { + "Question": "What is the total time", + "Description": "time spent", + "AnswerSetId": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "AllowNa": false + } + } } } } @@ -3748,10 +5265,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteInsightsQuestionnairesQuestion" } }, "/v1/Insights/Segments": { @@ -3760,7 +5274,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "segment_id", @@ -3769,9 +5283,9 @@ "agent_id", "queue" ], - "pathType": "list", "mountName": "insights_segments", - "className": "insights_segments" + "className": "insights_segments", + "pathType": "list" }, "get": { "description": "To get segments for given reservation Ids", @@ -3790,6 +5304,11 @@ "description": "To unique id of the segment", "schema": { "type": "string" + }, + "examples": { + "readBySegmentId": { + "value": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } } }, { @@ -3804,6 +5323,20 @@ "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "WReeeff42d5326cfdaa0f7a1181d00f1b1", + "WReeeff42d5326cfdaa0f7a1181d00f1b2" + ] + }, + "readByReservationIds": { + "value": [ + "WReeeff42d5326cfdaa0f7a1181d00f1b1", + "WReeeff42d5326cfdaa0f7a1181d00f1b2" + ] + } } }, { @@ -3849,16 +5382,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3867,17 +5402,117 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "segments": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "next_page_url": null, + "key": "segments" + } + } + }, + "readByReservationIds": { + "value": { + "segments": [ + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5", + "external_id": "EV4ab3c50aeeb9dc48c96f7290cf626a37", + "queue": "Everyone", + "external_contact": "+13051515226", + "external_segment_link_id": null, + "date": "2022-02-08T08:00:00Z", + "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d", + "external_segment_link": null, + "agent_id": "0e4a8059-18a3-5e48-9efb-29ae3213e7fe", + "agent_phone": "+13051515226", + "agent_name": "Flex Insights", + "agent_team_name": "Everyone", + "agent_team_name_in_hierarchy": "Everyone", + "agent_link": null, + "customer_phone": "+420606078007", + "customer_name": "+420606078007", + "customer_link": null, + "segment_recording_offset": null, + "media": null, + "assessment_type": [ + null + ], + "assessment_percentage": [ + null + ], + "url": "https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0", + "next_page_url": null, + "key": "segments" + } + } + }, + "readBySegmentId": { + "value": { + "segments": [ + { + "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5", + "external_id": "EV4ab3c50aeeb9dc48c96f7290cf626a37", + "queue": "Everyone", + "external_contact": "+13051515226", + "external_segment_link_id": null, + "date": "2022-02-08T08:00:00Z", + "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d", + "external_segment_link": null, + "agent_id": "0e4a8059-18a3-5e48-9efb-29ae3213e7fe", + "agent_phone": "+13051515226", + "agent_name": "Flex Insights", + "agent_team_name": "Everyone", + "agent_team_name_in_hierarchy": "Everyone", + "agent_link": null, + "customer_phone": "+420606078007", + "customer_name": "+420606078007", + "customer_link": null, + "segment_recording_offset": null, + "media": null, + "assessment_type": [ + null + ], + "assessment_percentage": [ + null + ], + "url": "https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0", + "next_page_url": null, + "key": "segments" } } } @@ -3892,10 +5527,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsSegments", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsSegments" } }, "/v1/Insights/Session": { @@ -3904,7 +5536,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "workspace_id", @@ -3912,8 +5544,8 @@ "session_id", "base_url" ], - "pathType": "instance", - "mountName": "insights_session" + "mountName": "insights_session", + "pathType": "instance" }, "post": { "description": "To obtain session details for fetching reports and dashboards", @@ -3933,6 +5565,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_session" + }, + "examples": { + "create": { + "value": { + "session_expiry": "2022-09-27T09:28:01Z", + "workspace_id": "clbi1eelh1x8z4.......ijpnyu", + "session_id": "-----BEGIN PGP MESSAGE-----\n\nwcBMA11tX1FL13rp\u2026\u2026kHXd\n=vOBk\n-----END PGP MESSAGE-----\n", + "base_url": "https://analytics.ytica.com/", + "url": "https://flex-api.twilio.com/v1/Insights/Session" + } + } } } }, @@ -3944,10 +5587,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsSession", - "x-maturity": [ - "Preview" - ] + "operationId": "CreateInsightsSession" } }, "/v1/Insights/QualityManagement/Settings/AnswerSets": { @@ -3956,16 +5596,16 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "answer_sets", "answer_set_categories", "not_applicable" ], - "pathType": "list", "mountName": "insights_settings_answer_sets", - "className": "insights_settings_answer_sets" + "className": "insights_settings_answer_sets", + "pathType": "list" }, "get": { "description": "To get the Answer Set Settings for an Account", @@ -3985,6 +5625,86 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_settings_answersets" + }, + "examples": { + "read": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/AnswerSets", + "answer_sets": [ + { + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "id": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "name": "Yes, No", + "sort": 0, + "type": "select", + "answers": [ + { + "description": "Yes.", + "id": "4e34f701-8206-4670-b376-c9fe26bb3ca3", + "name": "Yes", + "score": 100, + "sort": 0 + }, + { + "description": "No or a very poor.", + "id": "5e926651-fa5d-4aba-86e1-8440bb8faa6c", + "name": "No", + "score": 0, + "sort": 1 + } + ] + }, + { + "category_id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "id": "675e8803-e7ca-4002-97f6-a29490450b1b", + "name": "Good, Poor", + "sort": 1, + "type": "select", + "answers": [ + { + "description": "Good.", + "id": "5aa6c6c0-05cf-4952-b9f9-9fdbe18cc79d", + "name": "Good", + "score": 100, + "sort": 0 + }, + { + "description": "Poor.", + "id": "d19f1c36-8331-44cc-9944-e94cb39e35e9", + "name": "Poor", + "score": 0, + "sort": 1 + } + ] + } + ], + "answer_set_categories": [ + { + "id": "1a8cac56-826c-4f85-ac14-9104811cf184", + "name": "Two Options", + "sort": 1 + }, + { + "id": "10c44902-0e6e-46b6-9378-d4665348b4b7", + "name": "Three Options", + "sort": 2 + }, + { + "id": "10c44902-0e6e-46b6-9378-d4665348b4b8", + "name": "Rating", + "sort": 3 + } + ], + "not_applicable": { + "description": "Not applicable for this call", + "id": "8dc58ae1-16ae-4e17-a357-799d06230fa3", + "name": "N/A", + "score": 0, + "sort": 0 + } + } + } } } }, @@ -3996,10 +5716,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsAnswersets", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsSettingsAnswersets" } }, "/v1/Insights/QualityManagement/Settings/CommentTags": { @@ -4008,13 +5725,13 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "comments" ], - "pathType": "list", - "mountName": "insights_settings_comment" + "mountName": "insights_settings_comment", + "pathType": "list" }, "get": { "description": "To get the Comment Settings for an Account", @@ -4034,6 +5751,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_settings_comment" + }, + "examples": { + "read": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "comments": [ + { + "default": false, + "id": "4c5ba39a-e192-4c5d-a41c-b765a833665b", + "name": "Good", + "sort": 0 + } + ], + "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/CommentTags" + } + } } } }, @@ -4045,10 +5778,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsComment", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsSettingsComment" } }, "/v1/Insights/UserRoles": { @@ -4057,14 +5787,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "roles" ], - "pathType": "instance", "mountName": "insights_user_roles", - "className": "insights_user_roles" + "className": "insights_user_roles", + "pathType": "instance" }, "get": { "description": "This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user", @@ -4084,6 +5814,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.insights_user_roles" + }, + "examples": { + "fetch": { + "value": { + "roles": [ + "wfo.full_access" + ], + "url": "https://flex-api.twilio.com/v1/Insights/UserRoles" + } + } } } }, @@ -4095,10 +5835,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsUserRoles", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsUserRoles" } }, "/v1/Interactions/{Sid}": { @@ -4107,16 +5844,16 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "dependentProperties": { "interaction_channel": "{interaction_sid: sid}" }, - "mountName": "interaction" + "mountName": "interaction", + "pathType": "instance" }, "get": { "description": "", @@ -4140,6 +5877,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction" + }, + "examples": { + "fetch": { + "value": { + "sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel": { + "type": "sms", + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "routing": { + "properties": { + "workflow_sid": "WWxx", + "attributes": "WWxx", + "task_channel_unique_name": "sms", + "routing_target": "WKXX", + "queue_name": "WQXX" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + } + } + } } } }, @@ -4151,10 +5912,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInteraction" } }, "/v1/Interactions": { @@ -4163,16 +5921,16 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "dependentProperties": { "interaction_channel": "{interaction_sid: sid}" }, - "mountName": "interaction" + "mountName": "interaction", + "pathType": "list" }, "post": { "description": "Create a new Interaction.", @@ -4182,6 +5940,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction" + }, + "examples": { + "create": { + "value": { + "sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel": { + "type": "sms", + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "routing": { + "reservation": null, + "properties": { + "date_updated": 1634845217, + "task_queue_entered_date": 1634845217, + "workflow_name": "Default Fifo Workflow", + "age_in_queue": 0, + "task_channel_unique_name": "default", + "assignment_status": "pending", + "queue_name": "Sample Queue", + "assignmentCounter": 0, + "priority": 0, + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reason": "", + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"initiated_by\":\"customer\",\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"initiatedBy\":\"customer\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"direction\":\"inbound\"}", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "age": 0, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout": 86400, + "date_created": 1634845217, + "addons": "{}", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + } + } + } } } }, @@ -4194,9 +5994,6 @@ } ], "operationId": "CreateInteraction", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4215,6 +6012,14 @@ "Channel", "Routing" ] + }, + "examples": { + "create": { + "value": { + "Channel": "{\"type\":\"sms\",\"initiated_by\":\"customer\"}", + "Routing": "{}" + } + } } } } @@ -4227,18 +6032,18 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "dependentProperties": { "interaction_channel_invite": "{interaction_sid: interaction_sid, channel_sid: sid}", "interaction_channel_participant": "{interaction_sid: interaction_sid, channel_sid: sid}" }, "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "className": "interaction_channel", + "pathType": "instance" }, "get": { "description": "Fetch a Channel for an Interaction.", @@ -4274,6 +6079,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "type": "chat", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "closed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites" + } + } + } } } }, @@ -4285,10 +6107,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteractionChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInteractionChannel" }, "post": { "description": "Update an existing Interaction Channel.", @@ -4324,6 +6143,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + }, + "examples": { + "update": { + "value": { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "chat", + "status": "closed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites" + } + } + }, + "updateStatusClosed": { + "value": { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "chat", + "status": "failed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites" + } + } + } } } }, @@ -4336,9 +6187,6 @@ } ], "operationId": "UpdateInteractionChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4358,6 +6206,18 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "closed" + } + }, + "updateStatusClosed": { + "value": { + "Status": "closed" + } + } } } } @@ -4370,18 +6230,18 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "dependentProperties": { "interaction_channel_invite": "{interaction_sid: interaction_sid, channel_sid: sid}", "interaction_channel_participant": "{interaction_sid: interaction_sid, channel_sid: sid}" }, "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "className": "interaction_channel", + "pathType": "list" }, "get": { "description": "List all Channels for an Interaction.", @@ -4441,16 +6301,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4459,17 +6321,97 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "channels": [ + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "type": "chat", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "closed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "type": "sms", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "active", + "error_code": null, + "error_message": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3", + "type": "email", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4", + "type": "voice", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "setup", + "error_code": null, + "error_message": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Invites" + } + }, + { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5", + "type": "gbm", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "error_code": 19025, + "error_message": "Channel validation error", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5", + "links": { + "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Participants", + "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Invites" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -4484,10 +6426,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListInteractionChannel" } }, "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites": { @@ -4496,14 +6435,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_invite" + "className": "interaction_channel_invite", + "pathType": "list" }, "post": { "description": "Invite an Agent or a TaskQueue to a Channel.", @@ -4539,6 +6478,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + }, + "examples": { + "create": { + "value": { + "sid": "KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing": { + "reservation": null, + "properties": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": 1634845217, + "date_updated": 1634845217, + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "assignment_status": "pending", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_name": "Default Fifo Workflow", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "queue_name": "Sample Queue", + "priority": 0, + "age": 0, + "reason": "", + "timeout": 86400, + "assignmentCounter": 0, + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_entered_date": 1634845217, + "age_in_queue": 0, + "addons": "{}" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4551,9 +6527,6 @@ } ], "operationId": "CreateInteractionChannelInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4568,6 +6541,13 @@ "required": [ "Routing" ] + }, + "examples": { + "create": { + "value": { + "Routing": "{\"properties\":{\"workspace_sid\":\"WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"workflow_sid\":\"WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"worker_sid\":\"WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"queue_sid\":\"WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"attributes\":{\"customerName\":\"customer name\",\"customerAddress\":\"customer email address\"}}}" + } + } } } } @@ -4643,16 +6623,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4661,17 +6643,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "invites": [ + { + "sid": "KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing": { + "reservation": null, + "properties": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": 1634845217, + "date_updated": 1634845217, + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "assignment_status": "pending", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_name": "Default Fifo Workflow", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "queue_name": "Sample Queue", + "priority": 0, + "age": 0, + "reason": "", + "timeout": 86400, + "assignmentCounter": 0, + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_entered_date": 1634845217, + "age_in_queue": 0, + "addons": "{}" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + }, + { + "sid": "KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "routing": { + "reservation": null, + "properties": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": 1634845217, + "date_updated": 1634845217, + "attributes": "{\"customerAddress\":\"customer phone address\",\"flexChannelInviteSid\":\"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"conversationSid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"channelType\":\"sms\",\"customers\":{\"phone\":\"customer phone address\",\"name\":\"customer name\"},\"conversations\":{\"conversation_id\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"media\":[{\"type\":\"ChatTranscript\",\"sid\":\"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}]},\"customerName\":\"customer name\",\"flexInteractionChannelSid\":\"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"flexInteractionSid\":\"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}", + "assignment_status": "pending", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_name": "Default Fifo Workflow", + "queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "queue_name": "Sample Queue", + "priority": 0, + "age": 0, + "reason": "", + "timeout": 86400, + "assignmentCounter": 0, + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_entered_date": 1634845217, + "age_in_queue": 0, + "addons": "{}" + } + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0", + "next_page_url": null, + "key": "invites" } } } @@ -4686,10 +6749,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInteractionChannelInvite" } }, "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants": { @@ -4698,14 +6758,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_participant" + "className": "interaction_channel_participant", + "pathType": "list" }, "post": { "description": "Add a Participant to a Channel.", @@ -4741,6 +6801,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" + }, + "examples": { + "create": { + "value": { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "customer", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + } + } } } }, @@ -4753,9 +6824,6 @@ } ], "operationId": "CreateInteractionChannelParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4776,6 +6844,14 @@ "Type", "MediaProperties" ] + }, + "examples": { + "create": { + "value": { + "Type": "customer", + "MediaProperties": "{\"level\": \"to\", \"name\": \"Random Person test\", \"address\":\"random@person.com\", \"type\": \"email\"}" + } + } } } } @@ -4851,16 +6927,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4869,17 +6947,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "participants": [ + { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "customer", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + }, + { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "agent", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" } } } @@ -4894,10 +7001,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListInteractionChannelParticipant" } }, "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}": { @@ -4906,14 +7010,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_participant" + "className": "interaction_channel_participant", + "pathType": "instance" }, "post": { "description": "Update an existing Channel Participant.", @@ -4961,6 +7065,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" + }, + "examples": { + "update": { + "value": { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "agent", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + } + }, + "updateStatusClosed": { + "value": { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "agent", + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + } + } } } }, @@ -4973,9 +7097,6 @@ } ], "operationId": "UpdateInteractionChannelParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4992,6 +7113,18 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "closed" + } + }, + "updateStatusClosed": { + "value": { + "Status": "closed" + } + } } } } @@ -5004,14 +7137,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "flex_flow_sid" ], - "pathType": "list", - "mountName": "web_channel" + "mountName": "web_channel", + "pathType": "list" }, "get": { "description": "", @@ -5059,16 +7192,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5077,18 +7212,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [ + { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0", + "next_page_url": null, + "key": "flex_chat_channels" + }, + "flex_chat_channels": [] } } } @@ -5102,10 +7274,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListWebChannel" }, "post": { "description": "", @@ -5115,6 +7284,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.web_channel" + }, + "examples": { + "create": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5127,9 +7308,6 @@ } ], "operationId": "CreateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5171,6 +7349,17 @@ "CustomerFriendlyName", "ChatFriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FlexFlowSid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Identity": "abc", + "ChatFriendlyName": "firendly1", + "CustomerFriendlyName": "friendly2", + "PreEngagementData": "{}" + } + } } } } @@ -5183,14 +7372,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "flex_flow_sid" ], - "pathType": "instance", - "mountName": "web_channel" + "mountName": "web_channel", + "pathType": "instance" }, "get": { "description": "", @@ -5214,6 +7403,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.web_channel" + }, + "examples": { + "fetch": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5225,10 +7426,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWebChannel" }, "post": { "description": "", @@ -5252,6 +7450,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.web_channel" + }, + "examples": { + "update": { + "value": { + "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "url": "https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5264,9 +7474,6 @@ } ], "operationId": "UpdateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5284,6 +7491,14 @@ "description": "The post-engagement data." } } + }, + "examples": { + "update": { + "value": { + "ChatStatus": "inactive", + "PostEngagementData": "{}" + } + } } } } @@ -5315,10 +7530,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWebChannel" } } }, @@ -5326,15 +7538,5 @@ { "url": "https://flex-api.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index 91ff3409..9a1b1860 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -1,6 +1,31 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "conductor_flow_enum_flow_type": { + "type": "string", + "enum": [ + "StartInboundMessaging", + "StartOutboundVoice", + "AcceptInvite", + "EndInboundMessaging", + "EndOutboundVoice" + ] + }, + "conductor_flow_enum_name": { + "type": "string", + "enum": [ + "AcceptInviteFlow", + "EndInboundMessagingFlow", + "StartInboundMessagingFlow", + "StartOutboundVoiceFlow" + ] + }, "flex.v2.web_channel": { "type": "object", "properties": { @@ -19,12 +44,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -40,7 +59,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -50,14 +69,14 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conversation_sid" ], - "pathType": "list", "mountName": "web_channels", - "className": "web_channels" + "className": "web_channels", + "pathType": "list" }, "post": { "description": "", @@ -67,6 +86,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v2.web_channel" + }, + "examples": { + "create": { + "value": { + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "seinfeld" + } + } } } }, @@ -79,9 +106,6 @@ } ], "operationId": "CreateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -109,6 +133,15 @@ "required": [ "AddressSid" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChatFriendlyName": "LoquaciousLarry", + "CustomerFriendlyName": "LarryDavid" + } + } } } } @@ -120,11 +153,5 @@ { "url": "https://flex-api.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_frontline_v1.json b/spec/json/twilio_frontline_v1.json index 3b22c5ad..7807c541 100644 --- a/spec/json/twilio_frontline_v1.json +++ b/spec/json/twilio_frontline_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "frontline.v1.user": { "type": "object", @@ -53,12 +59,6 @@ "deactivated" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -74,7 +74,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -111,6 +111,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/frontline.v1.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "john@example.com", + "friendly_name": "John Doe", + "avatar": "https://example.com/profile.png", + "state": "active", + "is_available": true, + "url": "https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -122,10 +135,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUser" }, "post": { "description": "Update an existing frontline user", @@ -146,6 +156,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/frontline.v1.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "john@example.com", + "friendly_name": "John Doe", + "avatar": "https://example.com/profile.png", + "state": "active", + "is_available": true, + "url": "https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -158,9 +181,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -186,6 +206,16 @@ "description": "Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing)." } } + }, + "examples": { + "update": { + "value": { + "State": "active", + "FriendlyName": "Name", + "Avatar": "https://example.com/avatar.png", + "IsAvailable": true + } + } } } } @@ -197,11 +227,5 @@ { "url": "https://frontline-api.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index 5d165714..e63f6fa9 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "insights.v1.account_settings": { "type": "object", @@ -9,20 +15,24 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "advanced_features": { "type": "boolean", - "nullable": true + "nullable": true, + "description": "A boolean flag indicating whether Advanced Features for Voice Insights are enabled." }, "voice_trace": { "type": "boolean", - "nullable": true + "nullable": true, + "description": "A boolean flag indicating whether Voice Trace is enabled." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." } } }, @@ -49,13 +59,13 @@ "type": "string", "$ref": "#/components/schemas/annotation_enum_answered_by", "nullable": true, - "description": "Which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: human, machine. human indicates the call was answered by a person. machine indicates the call was answered by an answering machine." + "description": "Specifies which entity answered the call as determined by Answering Machine Detection. Possible enumerated values, one of: `human`, `machine`. `human` indicates the call was answered by a person. `machine` indicates the call was answered by an answering machine." }, "connectivity_issue": { "type": "string", "$ref": "#/components/schemas/annotation_enum_connectivity_issue", "nullable": true, - "description": "Specify if the call had any connectivity issues. Possible enumerated values, one : no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability." + "description": "Specifies if the call had any connectivity issues. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`." }, "quality_issues": { "type": "array", @@ -63,27 +73,27 @@ "type": "string" }, "nullable": true, - "description": "Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call" + "description": "Specifies if the call had any subjective quality issues. Possible values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`." }, "spam": { "type": "boolean", "nullable": true, - "description": "Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call." + "description": "Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call." }, "call_score": { "type": "integer", "nullable": true, - "description": "Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]." + "description": "Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]." }, "comment": { "type": "string", "nullable": true, - "description": "Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments." }, "incident": { "type": "string", "nullable": true, - "description": "Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Incident or support ticket associated with this call. The `incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`." }, "url": { "type": "string", @@ -156,95 +166,120 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "answered_by": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_answered_by", - "nullable": true + "nullable": true, + "description": "The Answered By value for the summarized call based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for more detail." }, "call_type": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_call_type", - "nullable": true + "nullable": true, + "description": "The Call Type of the summarized Call. One of `carrier`, `sip`, `trunking` or `client`." }, "call_state": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_call_state", - "nullable": true + "nullable": true, + "description": "The Call State of the summarized Call. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`." }, "processing_state": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_processing_state", - "nullable": true + "nullable": true, + "description": "The Processing State of the Call Summary. The Processing State will be `partial` until the assembly of the Call Summary finishes, which occurs approximately 30 minutes after Call end. Then the Processing State changes to `complete`" }, "created_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS" }, "start_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was started, given in ISO 8601 format." }, "end_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was ended, given in ISO 8601 format." }, "duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was initiated and the call was ended" }, "connect_duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was answered and when it ended" }, "from": { - "nullable": true + "nullable": true, + "description": "The calling party." }, "to": { - "nullable": true + "nullable": true, + "description": "The called party." }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a PSTN call." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a Client call." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the SDK sensor library for Client calls." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call." }, "tags": { "type": "array", "items": { "type": "string" }, - "nullable": true + "nullable": true, + "description": "Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." }, "attributes": { - "nullable": true + "nullable": true, + "description": "Attributes capturing call-flow-specific details." }, "properties": { - "nullable": true + "nullable": true, + "description": "Contains edge-agnostic call-level details." }, "trust": { + "nullable": true, + "description": "Contains trusted communications details including Branded Call and verified caller ID." + }, + "annotation": { "nullable": true } } @@ -736,51 +771,62 @@ "properties": { "timestamp": { "type": "string", - "nullable": true + "nullable": true, + "description": "Event time." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "edge": { "type": "string", "$ref": "#/components/schemas/event_enum_twilio_edge", - "nullable": true + "nullable": true, + "description": "The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`." }, "group": { "type": "string", - "nullable": true + "nullable": true, + "description": "Event group." }, "level": { "type": "string", "$ref": "#/components/schemas/event_enum_level", - "nullable": true + "nullable": true, + "description": "The Level of this Event. One of `UNKNOWN`, `DEBUG`, `INFO`, `WARNING` or `ERROR`." }, "name": { "type": "string", - "nullable": true + "nullable": true, + "description": "Event name." }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways." } } }, @@ -809,43 +855,52 @@ "properties": { "timestamp": { "type": "string", - "nullable": true + "nullable": true, + "description": "Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "edge": { "type": "string", "$ref": "#/components/schemas/metric_enum_twilio_edge", - "nullable": true + "nullable": true, + "description": "The Twilio media edge this Metric was captured on. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`." }, "direction": { "type": "string", "$ref": "#/components/schemas/metric_enum_stream_direction", - "nullable": true + "nullable": true, + "description": "The Direction of the media stream from the perspective of the Twilio media edge. One of `unknown`, `inbound`, `outbound` or `both`." }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a PSTN call." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the SDK sensor library for Client calls." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a Client call." } } }, @@ -876,99 +931,122 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Account." }, "call_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique SID identifier of the Call." }, "call_type": { "type": "string", "$ref": "#/components/schemas/summary_enum_call_type", - "nullable": true + "nullable": true, + "description": "The Call Type of the summarized Call. One of `carrier`, `sip`, `trunking` or `client`." }, "call_state": { "type": "string", "$ref": "#/components/schemas/summary_enum_call_state", - "nullable": true + "nullable": true, + "description": "The Call State of the summarized Call. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`." }, "answered_by": { "type": "string", "$ref": "#/components/schemas/summary_enum_answered_by", - "nullable": true + "nullable": true, + "description": "The Answered By value for the summarized call based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for more detail." }, "processing_state": { "type": "string", "$ref": "#/components/schemas/summary_enum_processing_state", - "nullable": true + "nullable": true, + "description": "The Processing State of the Call Summary. The Processing State will be `partial` until the assembly of the Call Summary finishes, which occurs approximately 30 minutes after Call end. Then the Processing State changes to `complete`" }, "created_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS" }, "start_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was started, given in ISO 8601 format." }, "end_time": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The time at which the Call was ended, given in ISO 8601 format." }, "duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was initiated and the call was ended" }, "connect_duration": { "type": "integer", - "nullable": true + "nullable": true, + "description": "Duration between when the call was answered and when it ended" }, "from": { - "nullable": true + "nullable": true, + "description": "The calling party." }, "to": { - "nullable": true + "nullable": true, + "description": "The called party." }, "carrier_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a PSTN call." }, "client_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a Client call." }, "sdk_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the SDK sensor library for Client calls." }, "sip_edge": { - "nullable": true + "nullable": true, + "description": "Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call." }, "tags": { "type": "array", "items": { "type": "string" }, - "nullable": true + "nullable": true, + "description": "Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." }, "attributes": { - "nullable": true + "nullable": true, + "description": "Attributes capturing call-flow-specific details." }, "properties": { - "nullable": true + "nullable": true, + "description": "Contains edge-agnostic call-level details." }, "trust": { - "nullable": true + "nullable": true, + "description": "Contains trusted communications details including Branded Call and verified caller ID." }, "annotation": { - "nullable": true + "nullable": true, + "description": "Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API." } } }, @@ -1409,12 +1487,6 @@ "tokyo" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1430,7 +1502,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1440,7 +1512,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "advanced_features", @@ -1449,12 +1521,12 @@ "pathType": "instance" }, "get": { - "description": "", + "description": "Get the Voice Insights Settings.", "parameters": [ { "name": "SubaccountSid", "in": "query", - "description": "", + "description": "The unique SID identifier of the Subaccount.", "schema": { "type": "string", "minLength": 34, @@ -1469,6 +1541,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.account_settings" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_trace": true, + "advanced_features": true, + "url": "https://insights.twilio.com/v1/Voice/Settings" + } + } } } }, @@ -1480,19 +1562,26 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccountSettings" }, "post": { - "description": "", + "description": "Update a specific Voice Insights Setting.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.account_settings" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "voice_trace": true, + "advanced_features": true, + "url": "https://insights.twilio.com/v1/Voice/Settings" + } + } } } }, @@ -1505,9 +1594,6 @@ } ], "operationId": "UpdateAccountSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1517,18 +1603,27 @@ "properties": { "AdvancedFeatures": { "type": "boolean", - "description": "" + "description": "A boolean flag to enable Advanced Features for Voice Insights." }, "VoiceTrace": { "type": "boolean", - "description": "" + "description": "A boolean flag to enable Voice Trace." }, "SubaccountSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "description": "" + "description": "The unique SID identifier of the Subaccount." + } + } + }, + "examples": { + "update": { + "value": { + "VoiceTrace": true, + "AdvancedFeatures": true, + "SubaccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" } } } @@ -1543,17 +1638,17 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "call_sid", "account_sid" ], - "pathType": "instance", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "instance" }, "post": { - "description": "Create/Update the annotation for the call", + "description": "Update an Annotation for a specific Call.", "parameters": [ { "name": "CallSid", @@ -1574,6 +1669,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call.annotation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answered_by": "human", + "connectivity_issue": "invalid_number", + "quality_issues": [ + "low_volume", + "choppy_robotic" + ], + "spam": true, + "call_score": 2, + "comment": "this is a call", + "incident": "https://twilio.zendesk.com/support/tickets/17353089", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation" + } + } } } }, @@ -1586,9 +1700,6 @@ } ], "operationId": "UpdateAnnotation", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1599,20 +1710,20 @@ "AnsweredBy": { "type": "string", "$ref": "#/components/schemas/annotation_enum_answered_by", - "description": "Which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: human, machine. human indicates the call was answered by a person. machine indicates the call was answered by an answering machine." + "description": "Specify which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: `human`, `machine`. `human` indicates the call was answered by a person. `machine` indicates the call was answered by an answering machine." }, "ConnectivityIssue": { "type": "string", "$ref": "#/components/schemas/annotation_enum_connectivity_issue", - "description": "Specify if the call had any connectivity issues. Possible enumerated values, one : no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability." + "description": "Specify if the call had any connectivity issues. Possible enumerated values, one of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`." }, "QualityIssues": { "type": "string", - "description": "Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call" + "description": "Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call." }, "Spam": { "type": "boolean", - "description": "Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call." + "description": "A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call." }, "CallScore": { "type": "integer", @@ -1621,11 +1732,24 @@ }, "Comment": { "type": "string", - "description": "Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`." }, "Incident": { "type": "string", - "description": "Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don\u2019t put any PII in here." + "description": "Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`." + } + } + }, + "examples": { + "update": { + "value": { + "AnsweredBy": "human", + "ConnectivityIssue": "invalid_number", + "QualityIssues": "low_volume,choppy_robotic", + "Spam": true, + "CallScore": 2, + "Comment": "this is a call", + "Incident": "https://twilio.zendesk.com/support/tickets/17353089" } } } @@ -1634,7 +1758,7 @@ } }, "get": { - "description": "Fetch a specific Annotation.", + "description": "Get the Annotation for a specific Call.", "parameters": [ { "name": "CallSid", @@ -1655,6 +1779,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call.annotation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answered_by": "human", + "connectivity_issue": "invalid_number", + "quality_issues": [ + "low_volume" + ], + "spam": true, + "call_score": 2, + "comment": "this is a call", + "incident": "https://twilio.zendesk.com/support/tickets/17353089", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation" + } + } } } }, @@ -1666,10 +1808,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAnnotation", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAnnotation" } }, "/v1/Voice/{Sid}": { @@ -1678,17 +1817,17 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "event": "{call_sid: sid}", "metric": "{call_sid: sid}", "call_summary": "{call_sid: sid}", "annotation": "{call_sid: sid}" }, - "mountName": "calls" + "mountName": "calls", + "pathType": "instance" }, "get": { "description": "", @@ -1712,6 +1851,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call" + }, + "examples": { + "fetch": { + "value": { + "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "events": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events", + "metrics": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics", + "summary": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary", + "annotation": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation" + } + } + } } } }, @@ -1723,10 +1876,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCall", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCall" } }, "/v1/Voice/Summaries": { @@ -1735,7 +1885,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -1748,17 +1898,17 @@ "call_type", "call_state" ], - "pathType": "list", "mountName": "call_summaries", - "className": "call_summaries" + "className": "call_summaries", + "pathType": "list" }, "get": { - "description": "", + "description": "Get a list of Call Summaries.", "parameters": [ { "name": "From", "in": "query", - "description": "", + "description": "A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.", "schema": { "type": "string" } @@ -1766,7 +1916,7 @@ { "name": "To", "in": "query", - "description": "", + "description": "A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.", "schema": { "type": "string" } @@ -1774,7 +1924,7 @@ { "name": "FromCarrier", "in": "query", - "description": "", + "description": "An origination carrier.", "schema": { "type": "string" } @@ -1782,15 +1932,20 @@ { "name": "ToCarrier", "in": "query", - "description": "", + "description": "A destination carrier.", "schema": { "type": "string" + }, + "examples": { + "readWithCarrier": { + "value": "AT&T Wireless" + } } }, { "name": "FromCountryCode", "in": "query", - "description": "", + "description": "A source country code based on phone number in From.", "schema": { "type": "string" } @@ -1798,7 +1953,7 @@ { "name": "ToCountryCode", "in": "query", - "description": "", + "description": "A destination country code. Based on phone number in To.", "schema": { "type": "string" } @@ -1806,7 +1961,7 @@ { "name": "Branded", "in": "query", - "description": "", + "description": "A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.", "schema": { "type": "boolean" } @@ -1814,31 +1969,55 @@ { "name": "VerifiedCaller", "in": "query", - "description": "", + "description": "A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.", "schema": { "type": "boolean" + }, + "examples": { + "readWithTrust": { + "value": true + } } }, { "name": "HasTag", "in": "query", - "description": "", + "description": "A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).", "schema": { "type": "boolean" + }, + "examples": { + "readWithSubaccount": { + "value": true + } } }, { "name": "StartTime", "in": "query", - "description": "", + "description": "A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.", "schema": { "type": "string" + }, + "examples": { + "readWithCarrier": { + "value": "4h" + }, + "readWithSubaccount": { + "value": "7d" + }, + "readWithTrust": { + "value": "1d" + }, + "readWithAbnormalSession": { + "value": "15d" + } } }, { "name": "EndTime", "in": "query", - "description": "", + "description": "An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.", "schema": { "type": "string" } @@ -1846,31 +2025,49 @@ { "name": "CallType", "in": "query", - "description": "", + "description": "A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.", "schema": { "type": "string" + }, + "examples": { + "readWithSubaccount": { + "value": "client" + }, + "readWithAbnormalSession": { + "value": "sip,trunking" + } } }, { "name": "CallState", "in": "query", - "description": "", + "description": "A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.", "schema": { "type": "string" + }, + "examples": { + "readWithAbnormalSession": { + "value": "completed" + } } }, { "name": "Direction", "in": "query", - "description": "", + "description": "A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.", "schema": { "type": "string" + }, + "examples": { + "readWithTrust": { + "value": "outbound_api,outbound_dial,trunking_terminating" + } } }, { "name": "ProcessingState", "in": "query", - "description": "", + "description": "A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.", "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_processing_state_request" @@ -1879,7 +2076,7 @@ { "name": "SortBy", "in": "query", - "description": "", + "description": "A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.", "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_sort_by" @@ -1888,61 +2085,96 @@ { "name": "Subaccount", "in": "query", - "description": "", + "description": "A unique SID identifier of a Subaccount.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "examples": { + "readWithSubaccount": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } } }, { "name": "AbnormalSession", "in": "query", - "description": "", + "description": "A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.", "schema": { "type": "boolean" + }, + "examples": { + "readWithAbnormalSession": { + "value": true + } } }, { "name": "AnsweredBy", "in": "query", - "description": "", + "description": "An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.", "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_answered_by" + }, + "examples": { + "readWithCarrier": { + "value": "machine_start" + } } }, { - "name": "ConnectivityIssues", + "name": "ConnectivityIssue", "in": "query", - "description": "", + "description": "A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "invalid_number,dropped_call" + } } }, { - "name": "QualityIssues", + "name": "QualityIssue", "in": "query", - "description": "", + "description": "A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "choppy_robotic,echo" + } } }, { "name": "Spam", "in": "query", - "description": "", + "description": "A boolean flag indicating spam calls.", "schema": { "type": "boolean" + }, + "examples": { + "readWithAnnotationParameters": { + "value": true + } } }, { - "name": "CallScores", + "name": "CallScore", "in": "query", - "description": "", + "description": "A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "1,2" + } } }, { @@ -1988,16 +2220,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2006,18 +2240,1048 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0" + }, + "call_summaries": [] + } + }, + "readWithCarrier": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T03:40:25Z", + "start_time": "2021-08-25T03:40:25Z", + "end_time": "2021-08-25T03:40:45Z", + "duration": 20, + "connect_duration": 20, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "AT&T Wireless", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 33.42767, + "lon": -86.886475 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxxx", + "direction": "inbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 202, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.48209, + "avg": 0.483035 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 218, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.51868, + "avg": 0.364434 + } + } + } + }, + "tags": [ + "high_packet_loss", + "high_jitter" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 121, + "disconnected_by": "callee", + "direction": "inbound" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T02:20:25Z", + "start_time": "2021-08-25T02:20:25Z", + "end_time": "2021-08-25T02:40:45Z", + "duration": 18, + "connect_duration": 18, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "AT&T Wireless", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 33.42767, + "lon": -86.886475 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxxx", + "direction": "inbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 100, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.48209, + "avg": 0.483035 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 102, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.51868, + "avg": 0.364434 + } + } + } + }, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 121, + "disconnected_by": "callee", + "direction": "inbound" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithSubaccount": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "created_time": "2021-08-25T04:16:35Z", + "start_time": "2021-08-25T04:16:36Z", + "end_time": "2021-08-25T04:16:42Z", + "duration": 7, + "connect_duration": 6, + "call_type": "client", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "client:+15555555555", + "connection": "twilio_sdk" + }, + "to": { + "callee": "client:TBBXXXXXXXXXXXX", + "connection": "twilio_sdk" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xxx", + "external_media_ip": "54.xxx.xx.xxx", + "edge_location": "xxxxxx", + "direction": "inbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 252, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 5.60994, + "avg": 0.933334 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 229, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.960786, + "avg": 0.399859 + } + } + } + }, + "carrier_edge": null, + "tags": [ + "high_pdd" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 58, + "disconnected_by": "callee", + "direction": "inbound" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "created_time": "2021-08-25T04:16:35Z", + "start_time": "2021-08-25T04:16:37Z", + "end_time": "2021-08-25T04:16:40Z", + "duration": 5, + "connect_duration": 3, + "call_type": "client", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "Verizon", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "client:TBBTXXXXXX", + "connection": "twilio_sdk" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xxx", + "external_media_ip": "54.xxx.xx.xxx", + "edge_location": "xxxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 110, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.05918, + "avg": 0.461966 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 147, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.869174, + "avg": 0.319674 + } + } + } + }, + "carrier_edge": null, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 35, + "disconnected_by": "callee", + "direction": "outbound_api" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithTrust": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:31:18Z", + "start_time": "2021-08-25T14:31:22Z", + "end_time": "2021-08-25T14:32:02Z", + "duration": 44, + "connect_duration": 41, + "call_type": "trunking", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "ACS", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 60.268353, + "lon": -141.13632 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xx", + "twilio_signaling_ip": "54.xxx.xx.xx", + "external_signaling_ip": "54.xxx.xx.xx", + "sip_call_id": "xxxxx@0.0.0.0", + "user_agent": "xxxx", + "edge_location": "xxxxx", + "trunk_sid": "xxxxxxx", + "direction": "inbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 1953, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.76407, + "avg": 0.23138 + }, + "latency": { + "max": 0.386, + "avg": 0.3765 + } + } + } + }, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + } + }, + "tags": [ + "silence" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 1990, + "disconnected_by": "caller", + "direction": "trunking_terminating" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:03:31Z", + "start_time": "2021-08-25T14:03:32Z", + "end_time": "2021-08-25T14:03:38Z", + "duration": 7, + "connect_duration": 6, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "T-Mobile USA, Inc.", + "connection": "mobile", + "number_prefix": "1555", + "location": { + "lat": 34.186115, + "lon": -118.43555 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 229, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.10303, + "avg": 0.449886 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 273, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.410031, + "avg": 0.295951 + } + } + } + }, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 315, + "disconnected_by": "callee", + "direction": "outbound_api" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-24T22:28:17Z", + "start_time": "2021-08-24T22:28:20Z", + "end_time": "2021-08-24T22:28:23Z", + "duration": 4, + "connect_duration": 3, + "call_type": "carrier", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "connection": "pstn" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": null, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 103, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.596712, + "avg": 0.251725 + } + } + } + }, + "tags": [ + "silence" + ], + "attributes": null, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 105, + "disconnected_by": "caller", + "direction": "outbound_dial" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithAbnormalSession": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:46:40Z", + "start_time": "2021-08-25T14:46:40Z", + "end_time": "2021-08-25T14:46:52Z", + "duration": 12, + "connect_duration": 12, + "call_type": "sip", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "XO Communications, Inc.", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "sip:xxxx@xx.xxx.xx.xxx", + "connection": "sip_interface" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "xx.xxx.xx.xxx", + "twilio_signaling_ip": "xx.xx.xx.xx", + "external_media_ip": "xx.xxx.xx.xxx", + "external_signaling_ip": "xx.xxx.xx.xxx", + "sip_call_id": "xxxxxxxx@0.0.0.0", + "edge_location": "xxxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 525, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.554729, + "avg": 0.229541 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 245, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.03548, + "avg": 0.344092 + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 255, + "disconnected_by": "callee", + "direction": "outbound_dial" + }, + "trust": null, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:31:18Z", + "start_time": "2021-08-25T14:31:22Z", + "end_time": "2021-08-25T14:32:02Z", + "duration": 44, + "connect_duration": 41, + "call_type": "trunking", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "ACS", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 60.268353, + "lon": -141.13632 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xx", + "twilio_signaling_ip": "54.xxx.xx.xx", + "external_signaling_ip": "54.xxx.xx.xx", + "sip_call_id": "xxxxx@0.0.0.0", + "user_agent": "xxxx", + "edge_location": "xxxxx", + "trunk_sid": "xxxxxxx", + "direction": "inbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 1953, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.76407, + "avg": 0.23138 + }, + "latency": { + "max": 0.386, + "avg": 0.3765 + } + } + } + }, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + } + }, + "tags": [ + "silence" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 1990, + "disconnected_by": "caller", + "direction": "trunking_terminating" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": null, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + }, + "readWithAnnotationParameters": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Voice/Summaries?QualityIssue=choppy_robotic%2Cecho&CallScore=1%2C2&ConnectivityIssue=invalid_number%2Cdropped_call&Spam=True&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?QualityIssue=choppy_robotic%2Cecho&CallScore=1%2C2&ConnectivityIssue=invalid_number%2Cdropped_call&Spam=True&PageSize=25&Page=0" + }, + "call_summaries": [ + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:46:40Z", + "start_time": "2021-08-25T14:46:40Z", + "end_time": "2021-08-25T14:46:52Z", + "duration": 12, + "connect_duration": 12, + "call_type": "sip", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "XO Communications, Inc.", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 40.83885, + "lon": -74.04568 + }, + "country_code": "US" + }, + "to": { + "callee": "sip:xxxx@xx.xxx.xx.xxx", + "connection": "sip_interface" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "xx.xxx.xx.xxx", + "twilio_signaling_ip": "xx.xx.xx.xx", + "external_media_ip": "xx.xxx.xx.xxx", + "external_signaling_ip": "xx.xxx.xx.xxx", + "sip_call_id": "xxxxxxxx@0.0.0.0", + "edge_location": "xxxxx", + "direction": "outbound" + }, + "metrics": { + "inbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_received": 525, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 0.554729, + "avg": 0.229541 + } + }, + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 245, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.03548, + "avg": 0.344092 + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "tags": null, + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 255, + "disconnected_by": "callee", + "direction": "outbound_dial" + }, + "trust": null, + "annotation": { + "spam": true, + "connectivity_issue": "invalid_number", + "quality_issues": [ + "choppy_robotic" + ], + "call_score": 1 + }, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + }, + { + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_time": "2021-08-25T14:31:18Z", + "start_time": "2021-08-25T14:31:22Z", + "end_time": "2021-08-25T14:32:02Z", + "duration": 44, + "connect_duration": 41, + "call_type": "trunking", + "call_state": "completed", + "answered_by": "machine_start", + "from": { + "caller": "+15555555555", + "carrier": "ACS", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 60.268353, + "lon": -141.13632 + }, + "country_code": "US" + }, + "to": { + "callee": "+15555555556", + "carrier": "Hawaiian Telcom, Inc. - HI", + "connection": "landline", + "number_prefix": "1555", + "location": { + "lat": 20.956036, + "lon": -157.23793 + }, + "country_code": "US" + }, + "processing_state": "complete", + "sdk_edge": null, + "sip_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "twilio_media_ip": "54.xxx.xx.xx", + "twilio_signaling_ip": "54.xxx.xx.xx", + "external_signaling_ip": "54.xxx.xx.xx", + "sip_call_id": "xxxxx@0.0.0.0", + "user_agent": "xxxx", + "edge_location": "xxxxx", + "trunk_sid": "xxxxxxx", + "direction": "inbound" + }, + "metrics": { + "outbound": { + "codec": 0, + "codec_name": "pcmu", + "packets_sent": 1953, + "packets_lost": 0, + "packets_loss_percentage": 0.0, + "jitter": { + "max": 1.76407, + "avg": 0.23138 + }, + "latency": { + "max": 0.386, + "avg": 0.3765 + } + } + } + }, + "client_edge": null, + "carrier_edge": { + "properties": { + "media_region": "us1", + "signaling_region": "us1", + "edge_location": "xxxx", + "direction": "outbound" + } + }, + "tags": [ + "silence" + ], + "attributes": { + "conference_participant": false + }, + "properties": { + "last_sip_response_num": 200, + "pdd_ms": 1990, + "disconnected_by": "caller", + "direction": "trunking_terminating" + }, + "trust": { + "verified_caller": { + "verified": true + } + }, + "annotation": { + "spam": true, + "connectivity_issue": "invalid_number", + "quality_issues": [ + "choppy_robotic" + ], + "call_score": 1 + }, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] } } } @@ -2031,10 +3295,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallSummaries", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallSummaries" } }, "/v1/Conferences/{ConferenceSid}": { @@ -2043,19 +3304,19 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conference_sid", "account_sid" ], - "pathType": "instance", "dependentProperties": { "conference_participant": "{conference_sid: conference_sid}" - } + }, + "pathType": "instance" }, "get": { - "description": "Fetch a specific Conference.", + "description": "Get a specific Conference Summary.", "parameters": [ { "name": "ConferenceSid", @@ -2076,6 +3337,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.conference" + }, + "examples": { + "fetch": { + "value": { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference1", + "start_time": "2021-10-08T02:58:51Z", + "create_time": "2021-10-08T02:58:47Z", + "end_time": "2021-10-08T03:00:02Z", + "duration_seconds": 76, + "connect_duration_seconds": 72, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 4, + "unique_participants": 4, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": "us1", + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 1, + "region_configuration": 0, + "participant_behavior": 3 + }, + "tags": [ + "duplicate_identity", + "detected_silence", + "participant_behavior_issues" + ], + "tag_info": { + "duplicate_identity": [ + { + "participant_identity": "client:+10000000000", + "participant_sids": [ + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ] + } + ] + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2087,10 +3397,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConference", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConference" } }, "/v1/Conferences": { @@ -2099,19 +3406,19 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conference_sid", "account_sid" ], - "pathType": "list", "dependentProperties": { "conference_participant": "{conference_sid: conference_sid}" - } + }, + "pathType": "list" }, "get": { - "description": "Retrieve a list of Conferences.", + "description": "Get a list of Conference Summaries.", "parameters": [ { "name": "ConferenceSid", @@ -2127,6 +3434,11 @@ "description": "Custom label for the conference resource, up to 64 characters.", "schema": { "type": "string" + }, + "examples": { + "readWithFriendlynameStartfailure": { + "value": "outboundConfCallTransferThrice_1" + } } }, { @@ -2135,6 +3447,14 @@ "description": "Conference status.", "schema": { "type": "string" + }, + "examples": { + "readWithRegion": { + "value": "completed" + }, + "readWithFriendlynameStartfailure": { + "value": "not_started" + } } }, { @@ -2143,6 +3463,11 @@ "description": "Conferences created after the provided timestamp specified in ISO 8601 format", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2021-10-09T17:20:53Z" + } } }, { @@ -2151,6 +3476,11 @@ "description": "Conferences created before the provided timestamp specified in ISO 8601 format.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2021-10-12T18:37:53Z" + } } }, { @@ -2159,6 +3489,11 @@ "description": "Twilio region where the conference media was mixed.", "schema": { "type": "string" + }, + "examples": { + "readWithRegion": { + "value": "au1" + } } }, { @@ -2167,6 +3502,11 @@ "description": "Tags applied by Twilio for common potential configuration, quality, or performance issues.", "schema": { "type": "string" + }, + "examples": { + "readWithDuplicateIdentity": { + "value": "duplicate_identity" + } } }, { @@ -2186,6 +3526,11 @@ "description": "Potential configuration, behavior, or performance issues detected during the conference.", "schema": { "type": "string" + }, + "examples": { + "readWithDetectedIssueEndreason": { + "value": "call_quality" + } } }, { @@ -2194,6 +3539,11 @@ "description": "Conference end reason; e.g. last participant left, modified by API, etc.", "schema": { "type": "string" + }, + "examples": { + "readWithDetectedIssueEndreason": { + "value": "participant_with_end_conference_on_exit_left" + } } }, { @@ -2239,16 +3589,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2257,18 +3609,347 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-10-12T18:11:10Z", + "create_time": "2021-10-12T18:11:09Z", + "end_time": "2021-10-12T18:11:15Z", + "duration_seconds": 7, + "connect_duration_seconds": 5, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 2, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 1, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": null, + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + }, + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 2", + "start_time": null, + "create_time": "2021-10-12T18:09:21Z", + "end_time": "2021-10-12T18:09:21Z", + "duration_seconds": 1, + "connect_duration_seconds": 0, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 3, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 1, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": [ + "detected_silence", + "participant_behavior_issues" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants" + } + } + ] + } + }, + "readWithRegion": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-10-12T18:19:10Z", + "create_time": "2021-10-12T18:19:09Z", + "end_time": "2021-10-12T18:20:17Z", + "duration_seconds": 7, + "connect_duration_seconds": 5, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 2, + "end_reason": "participant_with_end_conference_on_exit_kicked", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "au1", + "mixer_region_requested": "au1", + "recording_enabled": true, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 2, + "participant_behavior": 0 + }, + "tags": [ + "region_configuration_issues" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + }, + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 2", + "start_time": "2021-10-12T18:16:53Z", + "create_time": "2021-10-12T18:16:51Z", + "end_time": "2021-10-12T18:17:20Z", + "duration_seconds": 30, + "connect_duration_seconds": 27, + "status": "completed", + "max_participants": 250, + "max_concurrent_participants": 2, + "unique_participants": 2, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "mixer_region": "au1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 2, + "participant_behavior": 3 + }, + "tags": [ + "detected_silence", + "region_configuration_issues", + "participant_behavior_issues" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants" + } + } + ] + } + }, + "readWithFriendlynameStartfailure": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "outboundConfCallTransferThrice_1", + "start_time": null, + "create_time": "2021-11-18T00:09:09Z", + "end_time": "2021-11-18T00:09:52Z", + "duration_seconds": 7, + "connect_duration_seconds": 0, + "status": "not_started", + "max_participants": 250, + "max_concurrent_participants": 1, + "unique_participants": 1, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": null, + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": [ + "participant_behavior_issues", + "start_failure" + ], + "tag_info": { + "start_failure": { + "reason": "no_concurrent_participants" + } + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] + } + }, + "readWithDuplicateIdentity": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-11-17T16:21:45Z", + "create_time": "2021-11-17T16:21:40Z", + "end_time": "2021-11-17T16:22:11Z", + "duration_seconds": 32, + "connect_duration_seconds": 27, + "status": "not_started", + "max_participants": 250, + "max_concurrent_participants": 3, + "unique_participants": 4, + "end_reason": "last_participant_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 0, + "region_configuration": 0, + "participant_behavior": 0 + }, + "tags": [ + "duplicate_identity", + "detected_silence", + "participant_behavior_issues" + ], + "tag_info": { + "duplicate_identity": [ + { + "participant_identity": "client:+10000000000", + "participant_sids": [ + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ] + } + ] + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] + } + }, + "readWithDetectedIssueEndreason": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0", + "next_page_url": null, + "key": "conferences" + }, + "conferences": [ + { + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "conference 1", + "start_time": "2021-11-17T16:21:45Z", + "create_time": "2021-11-17T16:21:40Z", + "end_time": "2021-11-17T16:22:11Z", + "duration_seconds": 32, + "connect_duration_seconds": 27, + "status": "not_started", + "max_participants": 250, + "max_concurrent_participants": 3, + "unique_participants": 3, + "end_reason": "participant_with_end_conference_on_exit_left", + "ended_by": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "mixer_region": "us1", + "mixer_region_requested": null, + "recording_enabled": false, + "processing_state": "complete", + "detected_issues": { + "call_quality": 3, + "region_configuration": 0, + "participant_behavior": 1 + }, + "tags": [ + "high_packet_loss", + "low_mos", + "participant_behavior_issues", + "quality_warnings", + "high_jitter", + "detected_silence" + ], + "tag_info": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "conference_participants": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] } } } @@ -2282,10 +3963,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConference", - "x-maturity": [ - "GA" - ] + "operationId": "ListConference" } }, "/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}": { @@ -2294,7 +3972,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", @@ -2302,12 +3980,12 @@ "call_sid", "account_sid" ], - "pathType": "instance", "parent": "/Conferences/{ConferenceSid}", - "mountName": "conference_participants" + "mountName": "conference_participants", + "pathType": "instance" }, "get": { - "description": "Fetch a specific Conference Participant Summary.", + "description": "Get a specific Conference Participant Summary for a Conference.", "parameters": [ { "name": "ConferenceSid", @@ -2356,6 +4034,79 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.conference.conference_participant" + }, + "examples": { + "fetch": { + "value": { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+1000000001", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:59Z", + "leave_time": "2021-10-08T03:00:02Z", + "duration_seconds": 64, + "outbound_queue_length": 0, + "outbound_time_in_queue": 965, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": false, + "end_conference_on_exit": false, + "play_early_media": false, + "enter_muted": true, + "beep_on_enter": false, + "beep_on_exit": false + }, + "events": { + "mute": [ + 1633705131000 + ] + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 49, + "packet_loss_percentage": 0.0, + "jitter": { + "avg": 0.34, + "max": 0.53 + }, + "latency": { + "avg": 0.0, + "max": 0.0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 126, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.01, + "max": 0.01 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + } + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2367,10 +4118,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConferenceParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConferenceParticipant" } }, "/v1/Conferences/{ConferenceSid}/Participants": { @@ -2379,7 +4127,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", @@ -2387,12 +4135,12 @@ "call_sid", "account_sid" ], - "pathType": "list", "parent": "/Conferences/{ConferenceSid}", - "mountName": "conference_participants" + "mountName": "conference_participants", + "pathType": "list" }, "get": { - "description": "List Conference Participants.", + "description": "Get a list of Conference Participants Summaries for a Conference.", "parameters": [ { "name": "ConferenceSid", @@ -2420,6 +4168,11 @@ "description": "User-specified label for a participant.", "schema": { "type": "string" + }, + "examples": { + "readWithLabel": { + "value": "client" + } } }, { @@ -2473,16 +4226,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2491,18 +4246,250 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+10000000001", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:51Z", + "leave_time": "2021-10-08T02:59:55Z", + "duration_seconds": 65, + "outbound_queue_length": 0, + "outbound_time_in_queue": 3361, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": true, + "end_conference_on_exit": false, + "play_early_media": true, + "enter_muted": false, + "beep_on_enter": false, + "beep_on_exit": false + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 70, + "packet_loss_percentage": 0.0, + "jitter": { + "avg": 0.41, + "max": 0.84 + }, + "latency": { + "avg": 0.0, + "max": 0.0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 126, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.01, + "max": 0.01 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + } + }, + "events": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "label": null, + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+10000000002", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:52Z", + "leave_time": "2021-10-08T02:59:54Z", + "duration_seconds": 63, + "outbound_queue_length": 0, + "outbound_time_in_queue": 321, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": false, + "end_conference_on_exit": false, + "early_media": false, + "enter_muted": true, + "beep_on_enter": false, + "beep_on_exit": false + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 16, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.26, + "max": 0.45 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 42, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.03, + "max": 0.08 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4, + "tags": [ + "silent" + ] + } + }, + "events": { + "mute": [ + 1633705131000 + ] + }, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + ] + } + }, + "readWithLabel": { + "value": { + "meta": { + "page": 0, + "page_size": 25, + "first_page_url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0", + "previous_page_url": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0", + "next_page_url": null, + "key": "participants" + }, + "participants": [ + { + "participant_sid": "CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_direction": "outbound", + "from": "+10000000000", + "to": "+10000000001", + "call_status": "completed", + "country_code": "US", + "is_moderator": true, + "join_time": "2021-10-08T02:58:51Z", + "leave_time": "2021-10-08T02:59:55Z", + "duration_seconds": 65, + "label": "client", + "outbound_queue_length": 0, + "outbound_time_in_queue": 3361, + "jitter_buffer_size": null, + "is_coach": false, + "coached_participants": null, + "participant_region": "us1", + "conference_region": "us1", + "call_type": "carrier", + "processing_state": "complete", + "properties": { + "start_conference_on_enter": true, + "end_conference_on_exit": false, + "play_early_media": true, + "enter_muted": false, + "beep_on_enter": false, + "beep_on_exit": false + }, + "metrics": { + "inbound": { + "total_packets_lost": 0, + "total_packets_received": 70, + "packet_loss_percentage": 0.0, + "jitter": { + "avg": 0.41, + "max": 0.84 + }, + "latency": { + "avg": 0.0, + "max": 0.0 + }, + "mos": 4.4 + }, + "outbound": { + "total_packets_lost": 0, + "total_packets_received": 96, + "packet_loss_percentage": 0, + "jitter": { + "avg": 0.01, + "max": 0.01 + }, + "latency": { + "avg": 0, + "max": 0 + }, + "mos": 4.4 + } + }, + "events": null, + "url": "https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2516,10 +4503,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConferenceParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListConferenceParticipant" } }, "/v1/Voice/{CallSid}/Events": { @@ -2528,7 +4512,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "timestamp", @@ -2537,16 +4521,16 @@ "edge", "name" ], - "pathType": "list", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "list" }, "get": { - "description": "", + "description": "Get a list of Call Insight Events for a Call.", "parameters": [ { "name": "CallSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Call.", "schema": { "type": "string", "minLength": 34, @@ -2558,7 +4542,7 @@ { "name": "Edge", "in": "query", - "description": "", + "description": "The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.", "schema": { "type": "string", "$ref": "#/components/schemas/event_enum_twilio_edge" @@ -2607,16 +4591,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2625,18 +4611,136 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "events", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0" + }, + "events": [ + { + "timestamp": "2019-09-19T22:15:23Z", + "call_sid": "CA03a02b156c6faa96c86906f7e9ad0f38", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "group": "connection", + "name": "error", + "level": "ERROR", + "sdk_edge": { + "error": { + "code": 31600 + }, + "metadata": { + "client_name": "GTI9300323095d271b890c91568931321395", + "location": { + "lat": 37.4192, + "lon": -122.0574 + }, + "city": "Mountain View", + "country_code": "US", + "country_subdivision": "California", + "ip_address": "108.177.7.83", + "sdk": { + "type": "twilio-voice-android", + "version": "4.5.1", + "platform": "android", + "selected_region": "gll", + "os": { + "name": "android", + "version": "4.3" + }, + "device": { + "model": "GT-I9300", + "type": "GT-I9300", + "vendor": "samsung", + "arch": "armeabi-v7a" + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] + } + }, + "readDeep": { + "value": { + "meta": { + "page": 10, + "page_size": 5, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=0", + "previous_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=9&PageToken=DP10", + "next_page_url": null, + "key": "events", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=10" + }, + "events": [ + { + "timestamp": "2019-09-19T22:15:23Z", + "call_sid": "CA03a02b156c6faa96c86906f7e9ad0f38", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "group": "connection", + "name": "error", + "level": "ERROR", + "sdk_edge": { + "error": { + "code": 31600 + }, + "metadata": { + "client_name": "GTI9300323095d271b890c91568931321395", + "location": { + "lat": 37.4192, + "lon": -122.0574 + }, + "city": "Mountain View", + "country_code": "US", + "country_subdivision": "California", + "ip_address": "108.177.7.83", + "sdk": { + "type": "twilio-voice-android", + "version": "4.5.1", + "platform": "android", + "selected_region": "gll", + "os": { + "name": "android", + "version": "4.3" + }, + "device": { + "model": "GT-I9300", + "type": "GT-I9300", + "vendor": "samsung", + "arch": "armeabi-v7a" + } + } + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] } } } @@ -2650,10 +4754,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListEvent" } }, "/v1/Voice/{CallSid}/Metrics": { @@ -2662,7 +4763,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "timestamp", @@ -2671,16 +4772,16 @@ "edge", "direction" ], - "pathType": "list", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "list" }, "get": { - "description": "", + "description": "Get a list of Call Metrics for a Call.", "parameters": [ { "name": "CallSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Call.", "schema": { "type": "string", "minLength": 34, @@ -2692,19 +4793,29 @@ { "name": "Edge", "in": "query", - "description": "", + "description": "The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.", "schema": { "type": "string", "$ref": "#/components/schemas/metric_enum_twilio_edge" + }, + "examples": { + "readFull": { + "value": "sdk_edge" + } } }, { "name": "Direction", "in": "query", - "description": "", + "description": "The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.", "schema": { "type": "string", "$ref": "#/components/schemas/metric_enum_stream_direction" + }, + "examples": { + "readFull": { + "value": "both" + } } }, { @@ -2750,16 +4861,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2768,18 +4881,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "metrics", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0" + }, + "metrics": [ + { + "timestamp": "2019-10-07T22:32:06Z", + "call_sid": "CA7569efe0253644fa4a88aa97beca3310", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "direction": "both", + "sdk_edge": { + "interval": { + "packets_received": 50, + "packets_lost": 0, + "audio_in": { + "value": 81.0 + }, + "audio_out": { + "value": 5237.0 + }, + "jitter": { + "value": 9 + }, + "mos": { + "value": 4.39 + }, + "rtt": { + "value": 81 + } + }, + "cumulative": { + "bytes_received": 547788, + "bytes_sent": 329425, + "packets_received": 3900, + "packets_lost": 0, + "packets_sent": 3934 + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] + } + }, + "readFull": { + "value": { + "meta": { + "page": 10, + "page_size": 5, + "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=0", + "previous_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=9&PageToken=DP10", + "next_page_url": null, + "key": "metrics", + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=10" + }, + "metrics": [ + { + "timestamp": "2019-10-07T22:32:06Z", + "call_sid": "CA7569efe0253644fa4a88aa97beca3310", + "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9", + "edge": "sdk_edge", + "direction": "both", + "sdk_edge": { + "interval": { + "packets_received": 50, + "packets_lost": 0, + "audio_in": { + "value": 81.0 + }, + "audio_out": { + "value": 5237.0 + }, + "jitter": { + "value": 9 + }, + "mos": { + "value": 4.39 + }, + "rtt": { + "value": 81 + } + }, + "cumulative": { + "bytes_received": 547788, + "bytes_sent": 329425, + "packets_received": 3900, + "packets_lost": 0, + "packets_sent": 3934 + } + }, + "client_edge": null, + "carrier_edge": null, + "sip_edge": null + } + ] } } } @@ -2793,10 +5012,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMetric", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMetric" } }, "/v1/Voice/{CallSid}/Summary": { @@ -2805,7 +5021,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "call_type", @@ -2813,17 +5029,17 @@ "processing_state", "duration" ], - "pathType": "instance", "parent": "/Voice/{Sid}", - "className": "call_summary" + "className": "call_summary", + "pathType": "instance" }, "get": { - "description": "", + "description": "Get a specific Call Summary.", "parameters": [ { "name": "CallSid", "in": "path", - "description": "", + "description": "The unique SID identifier of the Call.", "schema": { "type": "string", "minLength": 34, @@ -2835,7 +5051,7 @@ { "name": "ProcessingState", "in": "query", - "description": "", + "description": "The Processing State of this Call Summary. One of `complete`, `partial` or `all`.", "schema": { "type": "string", "$ref": "#/components/schemas/summary_enum_processing_state" @@ -2848,6 +5064,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.call.summary" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_type": "carrier", + "call_state": "ringing", + "answered_by": "machine_start", + "processing_state": "complete", + "created_time": "2015-07-30T20:00:00Z", + "start_time": "2015-07-30T20:00:00Z", + "end_time": "2015-07-30T20:00:00Z", + "duration": 100, + "connect_duration": 99, + "from": {}, + "to": {}, + "carrier_edge": {}, + "client_edge": {}, + "sdk_edge": {}, + "sip_edge": {}, + "tags": [ + "tags" + ], + "attributes": {}, + "properties": {}, + "trust": {}, + "annotation": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "answered_by": "human", + "connectivity_issue": "invalid_number", + "quality_issues": [ + "low_volume" + ], + "spam": true, + "call_score": 2, + "comment": "this is a call", + "incident": "https://twilio.zendesk.com/support/tickets/17353089" + }, + "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary" + } + } } } }, @@ -2859,10 +5118,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSummary" } }, "/v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}": { @@ -2871,13 +5127,13 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid" ], - "pathType": "instance", - "parent": "/Video/Rooms/{RoomSid}" + "parent": "/Video/Rooms/{RoomSid}", + "pathType": "instance" }, "get": { "description": "Get Video Log Analyzer data for a Room Participant.", @@ -2907,6 +5163,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.video_room_summary.video_participant_summary" + }, + "examples": { + "fetch": { + "value": { + "publisher_info": {}, + "edge_location": "ashburn", + "join_time": "2015-07-30T20:00:00Z", + "leave_time": "2015-07-30T20:00:00Z", + "end_reason": "disconnected_via_api", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code": 0, + "media_region": "us1", + "properties": {}, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code_url": "error_code_url", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "codecs": [ + "VP8" + ], + "status": "in_progress", + "duration_sec": 50000000, + "participant_identity": "participant_identity", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2918,10 +5199,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVideoParticipantSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVideoParticipantSummary" } }, "/v1/Video/Rooms/{RoomSid}/Participants": { @@ -2930,13 +5208,13 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid" ], - "pathType": "list", - "parent": "/Video/Rooms/{RoomSid}" + "parent": "/Video/Rooms/{RoomSid}", + "pathType": "list" }, "get": { "description": "Get a list of room participants.", @@ -2993,16 +5271,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3011,18 +5291,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "key": "participants", + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "participants": [] + } + }, + "readFull": { + "value": { + "meta": { + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "key": "participants", + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "participants": [ + { + "publisher_info": {}, + "edge_location": "ashburn", + "join_time": "2015-07-30T20:00:00Z", + "leave_time": "2015-07-30T20:00:00Z", + "end_reason": "disconnected_via_api", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code": 53205, + "media_region": "us1", + "properties": {}, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "error_code_url": "error_code_url", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "codecs": [ + "VP8" + ], + "status": "in_progress", + "duration_sec": 50000000, + "participant_identity": "participant_identity", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -3036,10 +5366,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVideoParticipantSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVideoParticipantSummary" } }, "/v1/Video/Rooms/{RoomSid}": { @@ -3048,16 +5375,16 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "create_time" ], - "pathType": "instance", "dependentProperties": { "participant": "{room_sid: room_sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Get Video Log Analyzer data for a Room.", @@ -3078,6 +5405,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/insights.v1.video_room_summary" + }, + "examples": { + "fetch": { + "value": { + "room_type": "go", + "unique_participant_identities": 0, + "codecs": [ + "VP8" + ], + "max_participants": 0, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "create_time": "2015-07-30T20:00:00Z", + "end_reason": "room_ended_via_api", + "duration_sec": 50000000, + "room_status": "in_progress", + "media_region": "us1", + "recording_enabled": false, + "edge_location": "ashburn", + "max_concurrent_participants": 0, + "unique_participants": 0, + "room_name": "room_name", + "created_method": "sdk", + "total_participant_duration_sec": 50000000, + "status_callback_method": "GET", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "end_time": "2015-07-30T20:00:00Z", + "total_recording_duration_sec": 50000000, + "processing_state": "complete", + "concurrent_participants": 0, + "status_callback": "http://www.example.com", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -3089,10 +5452,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVideoRoomSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVideoRoomSummary" } }, "/v1/Video/Rooms": { @@ -3101,16 +5461,16 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "create_time" ], - "pathType": "list", "dependentProperties": { "participant": "{room_sid: room_sid}" - } + }, + "pathType": "list" }, "get": { "description": "Get a list of Programmable Video Rooms.", @@ -3208,16 +5568,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3226,18 +5588,79 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "key": "rooms", + "page": 0, + "previous_page_url": null + }, + "rooms": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "url": "https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0", + "page_size": 50, + "next_page_url": null, + "key": "rooms", + "page": 0, + "previous_page_url": null + }, + "rooms": [ + { + "room_type": "go", + "unique_participant_identities": 0, + "codecs": [ + "VP8" + ], + "max_participants": 0, + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "create_time": "2015-07-30T20:00:00Z", + "end_reason": "room_ended_via_api", + "duration_sec": 50000000, + "room_status": "in_progress", + "media_region": "us1", + "recording_enabled": false, + "edge_location": "ashburn", + "max_concurrent_participants": 0, + "unique_participants": 0, + "room_name": "room_name", + "created_method": "sdk", + "total_participant_duration_sec": 50000000, + "status_callback_method": "GET", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "end_time": "2015-07-30T20:00:00Z", + "total_recording_duration_sec": 50000000, + "processing_state": "complete", + "concurrent_participants": 0, + "status_callback": "http://www.example.com", + "url": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + ] } } } @@ -3251,10 +5674,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVideoRoomSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVideoRoomSummary" } } }, @@ -3262,19 +5682,5 @@ { "url": "https://insights.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - }, - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index 6606c98e..93be9fd6 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "intelligence.v2.transcript.media": { "type": "object", @@ -382,12 +388,6 @@ "unknown" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -403,7 +403,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -413,15 +413,15 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "service_sid", "sid" ], - "pathType": "instance", - "parent": "/Transcripts/{Sid}" + "parent": "/Transcripts/{Sid}", + "pathType": "instance" }, "get": { "description": "Get download URLs for media if possible", @@ -444,6 +444,11 @@ "description": "Grant access to PII Redacted/Unredacted Media. The default is `true` to access redacted media.", "schema": { "type": "boolean" + }, + "examples": { + "fetchParams": { + "value": "True" + } } } ], @@ -453,6 +458,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.media" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "media_url": "https://media.server.com/media.wav", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + }, + "fetchParams": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "media_url": "https://media.server.com/media.wav", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } } } }, @@ -464,10 +489,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMedia", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchMedia" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults": { @@ -476,13 +498,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "operator_sid" ], - "pathType": "list", - "parent": "/Transcripts/{Sid}" + "parent": "/Transcripts/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of Operator Results for the given Transcript.", @@ -505,6 +527,11 @@ "description": "Grant access to PII redacted/unredacted Language Understanding operator. The default is True.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "True" + } } }, { @@ -550,16 +577,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -568,17 +597,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "operator_results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0", + "next_page_url": null, + "key": "operator_results" + } + } + }, + "readFull": { + "value": { + "operator_results": [ + { + "operator_type": "conversation_classify", + "name": "name", + "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "extract_match": false, + "match_probability": "0.05", + "normalized_result": "normalized_result", + "utterance_results": [ + {} + ], + "utterance_match": false, + "predicted_label": "predicted_label", + "predicted_probability": "0.05", + "label_probabilities": {}, + "extract_results": {}, + "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=True&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=True&PageSize=50&Page=0", + "next_page_url": null, + "key": "operator_results" } } } @@ -593,10 +669,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOperatorResult", - "x-maturity": [ - "Beta" - ] + "operationId": "ListOperatorResult" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}": { @@ -605,13 +678,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "operator_sid" ], - "pathType": "instance", - "parent": "/Transcripts/{Sid}" + "parent": "/Transcripts/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Operator Result for the given Transcript.", @@ -646,6 +719,11 @@ "description": "Grant access to PII redacted/unredacted Language Understanding operator. The default is True.", "schema": { "type": "boolean" + }, + "examples": { + "fetch": { + "value": "False" + } } } ], @@ -655,6 +733,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.operator_result" + }, + "examples": { + "fetch": { + "value": { + "operator_type": "conversation_classify", + "name": "name", + "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "extract_match": false, + "match_probability": "0.05", + "normalized_result": "normalized_result", + "utterance_results": [ + {} + ], + "utterance_match": false, + "predicted_label": "predicted_label", + "predicted_probability": "0.05", + "label_probabilities": {}, + "extract_results": {}, + "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -666,10 +766,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOperatorResult", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchOperatorResult" } }, "/v2/Transcripts/{TranscriptSid}/Sentences": { @@ -678,7 +775,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -689,8 +786,8 @@ "end_time", "confidence" ], - "pathType": "list", - "parent": "/Transcripts/{Sid}" + "parent": "/Transcripts/{Sid}", + "pathType": "list" }, "get": { "description": "Get all Transcript Sentences by TranscriptSid", @@ -713,6 +810,11 @@ "description": "Grant access to PII Redacted/Unredacted Sentences. The default is `true` to access redacted sentences.", "schema": { "type": "boolean" + }, + "examples": { + "readParams": { + "value": "True" + } } }, { @@ -758,16 +860,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -776,17 +880,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "sentences": [ + { + "media_channel": 1, + "sentence_index": 0, + "start_time": null, + "end_time": null, + "transcript": "test test", + "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": null + } + ], + "meta": { + "key": "sentences", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null + } + } + }, + "readParams": { + "value": { + "sentences": [ + { + "media_channel": 1, + "sentence_index": 0, + "start_time": null, + "end_time": null, + "transcript": "test test", + "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": null + } + ], + "meta": { + "key": "sentences", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null } } } @@ -801,10 +953,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSentence", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSentence" } }, "/v2/Services": { @@ -813,7 +962,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -833,6 +982,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" + }, + "examples": { + "create": { + "value": { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "language_code": "en-US", + "webhook_url": "https://www.twilio.com", + "webhook_http_method": "POST", + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -845,9 +1015,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -896,6 +1063,17 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "something", + "FriendlyName": "some friendly name", + "LanguageCode": "en-US", + "WebhookUrl": "https://www.twilio.com", + "WebhookHttpMethod": "POST" + } + } } } } @@ -947,16 +1125,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -965,17 +1145,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "services": [ + { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "language_code": "en-US", + "webhook_url": "https://www.twilio.com", + "webhook_http_method": "POST", + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "key": "services", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "services": [], + "meta": { + "key": "services", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0" } } } @@ -990,10 +1216,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v2/Services/{Sid}": { @@ -1002,7 +1225,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1037,10 +1260,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "get": { "description": "Fetch a specific Service.", @@ -1061,6 +1281,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "language_code": "en-US", + "webhook_url": "https://www.twilio.com", + "webhook_http_method": "POST", + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1072,10 +1313,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "post": { "description": "Update a specific Service.", @@ -1104,6 +1342,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" + }, + "examples": { + "update": { + "value": { + "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "something", + "friendly_name": "some friendly name", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "auto_redaction": false, + "media_redaction": false, + "auto_transcribe": true, + "data_logging": true, + "webhook_url": "https://www.sendgrid.com", + "webhook_http_method": "GET", + "language_code": "en-US", + "version": 2, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1116,9 +1375,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1164,6 +1420,16 @@ "description": "The HTTP method for the Webhook. One of `GET` or `POST`." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "something", + "FriendlyName": "some friendly name", + "WebhookUrl": "https://www.sendgrid.com", + "WebhookHttpMethod": "GET" + } + } } } } @@ -1176,7 +1442,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1185,12 +1451,12 @@ "duration", "status" ], - "pathType": "list", "dependentProperties": { "sentence": "{transcript_sid: sid}", "media": "{sid: sid}", "operator_result": "{transcript_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new Transcript for the service", @@ -1200,6 +1466,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": { + "media_properties": { + "media_url": "http://foobar.test/ClusterTests/call1.wav" + } + }, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": "aaaaaaaa", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + }, + "createParams": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": { + "media_properties": { + "media_url": "http://foobar.test/ClusterTests/call1.wav" + } + }, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + } } } }, @@ -1212,9 +1534,6 @@ } ], "operationId": "CreateTranscript", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1246,6 +1565,22 @@ "ServiceSid", "Channel" ] + }, + "examples": { + "create": { + "value": { + "ServiceSid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Channel": "{ \"media_properties\" : { \"media_url\": \"http://foobar.test/ClusterTests/call1.wav\"}}", + "CustomerKey": "aaaaaaaa" + } + }, + "createParams": { + "value": { + "ServiceSid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Channel": "{ \"media_properties\" : { \"media_url\": \"http://foobar.test/ClusterTests/call1.wav\"}}", + "CustomerKey": "aaaaaaaa" + } + } } } } @@ -1263,6 +1598,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readQuery": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1295,6 +1641,11 @@ "description": "Filter by after DateCreated.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2019-11-22T23:46:00Z" + } } }, { @@ -1311,6 +1662,11 @@ "description": "Filter by Language Code.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "en-US" + } } }, { @@ -1319,6 +1675,11 @@ "description": "Filter by SourceSid.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1364,16 +1725,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1382,17 +1745,103 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "transcripts": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": {}, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + ], + "meta": { + "key": "transcripts", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "transcripts": [], + "meta": { + "key": "transcripts", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + } + } + }, + "readQuery": { + "value": { + "transcripts": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": {}, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + ], + "meta": { + "key": "transcripts", + "page": 0, + "page_size": 50, + "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } } @@ -1407,10 +1856,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "ListTranscript" } }, "/v2/Transcripts/{Sid}": { @@ -1419,7 +1865,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1428,12 +1874,12 @@ "duration", "status" ], - "pathType": "instance", "dependentProperties": { "sentence": "{transcript_sid: sid}", "media": "{sid: sid}", "operator_result": "{transcript_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Transcript.", @@ -1456,6 +1902,11 @@ "description": "Grant access to PII Redacted/Unredacted Transcript. The default is `true` to access redacted Transcript.", "schema": { "type": "boolean" + }, + "examples": { + "fetchParam": { + "value": "True" + } } } ], @@ -1465,6 +1916,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": {}, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + }, + "fetchParam": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "status": "queued", + "channel": {}, + "data_logging": false, + "language_code": "en-US", + "media_start_time": null, + "duration": 0, + "customer_key": null, + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "redaction": true, + "links": { + "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", + "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", + "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults" + } + } + } } } }, @@ -1476,10 +1975,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchTranscript" }, "delete": { "description": "Delete a specific Transcript.", @@ -1507,10 +2003,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteTranscript" } } }, @@ -1518,11 +2011,5 @@ { "url": "https://intelligence.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index a250349c..073a6023 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "ip_messaging.v1.service.channel": { "type": "object", @@ -659,12 +665,6 @@ "not_participating" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -680,7 +680,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -690,20 +690,20 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -736,6 +736,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -747,10 +772,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -787,10 +809,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -823,6 +842,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -835,9 +879,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -858,6 +899,16 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -870,20 +921,20 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -907,6 +958,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + } } } }, @@ -919,9 +995,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -947,6 +1020,16 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } @@ -1022,16 +1105,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1040,17 +1125,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1065,10 +1200,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v1/Credentials": { @@ -1077,7 +1209,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1132,16 +1264,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1150,17 +1284,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -1175,10 +1348,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -1188,6 +1358,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1200,9 +1384,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1243,6 +1424,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1255,7 +1443,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1286,6 +1474,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1297,10 +1499,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -1324,6 +1523,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1336,9 +1549,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1371,6 +1581,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -1402,10 +1619,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -1414,15 +1628,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1467,6 +1681,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1478,10 +1708,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -1530,10 +1757,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -1542,15 +1766,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1583,6 +1807,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1595,9 +1835,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1620,6 +1857,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1658,6 +1903,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -1703,16 +1960,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1721,17 +1980,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -1746,10 +2046,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -1758,15 +2055,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1811,6 +2108,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1822,10 +2136,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -1874,10 +2185,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -1922,6 +2230,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 666, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1934,9 +2274,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1957,6 +2294,18 @@ "description": "" } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 666 + } + } } } } @@ -1969,15 +2318,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2010,6 +2359,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2022,9 +2388,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2047,6 +2410,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio" + } + } } } } @@ -2130,16 +2500,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2148,18 +2520,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -2173,10 +2587,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -2185,7 +2596,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2193,8 +2604,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2242,6 +2653,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2253,10 +2683,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -2308,10 +2735,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -2359,6 +2783,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{\"test\": \"test\"}", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2371,9 +2814,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2390,6 +2830,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello" + } + } } } } @@ -2402,7 +2849,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2410,8 +2857,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2447,6 +2894,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAttributes": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2459,9 +2942,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2485,6 +2965,19 @@ "required": [ "Body" ] + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAttributes": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}" + } + } } } } @@ -2569,16 +3062,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2587,18 +3082,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -2612,10 +3151,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { @@ -2624,15 +3160,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2668,6 +3204,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2679,10 +3235,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -2722,10 +3275,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -2761,6 +3311,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2773,9 +3343,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2794,6 +3361,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -2806,15 +3380,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2838,6 +3412,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2850,9 +3444,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2882,6 +3473,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -2945,16 +3545,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2963,18 +3565,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -2988,10 +3635,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Services/{Sid}": { @@ -3000,19 +3644,19 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -3036,6 +3680,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3047,10 +3727,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -3078,10 +3755,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -3105,6 +3779,140 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": { + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template" + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": { + "on_channel_add": { + "format": "webhooks.on_channel_add.format", + "method": "webhooks.on_channel_add.method", + "url": "webhooks.on_channel_add.url" + }, + "on_channel_added": { + "format": "webhooks.on_channel_added.format", + "method": "webhooks.on_channel_added.method", + "url": "webhooks.on_channel_added.url" + }, + "on_channel_destroy": { + "format": "webhooks.on_channel_destroy.format", + "method": "webhooks.on_channel_destroy.method", + "url": "webhooks.on_channel_destroy.url" + }, + "on_channel_destroyed": { + "format": "webhooks.on_channel_destroyed.format", + "method": "webhooks.on_channel_destroyed.method", + "url": "webhooks.on_channel_destroyed.url" + }, + "on_channel_update": { + "format": "webhooks.on_channel_update.format", + "method": "webhooks.on_channel_update.method", + "url": "webhooks.on_channel_update.url" + }, + "on_channel_updated": { + "format": "webhooks.on_channel_updated.format", + "method": "webhooks.on_channel_updated.method", + "url": "webhooks.on_channel_updated.url" + }, + "on_member_add": { + "format": "webhooks.on_member_add.format", + "method": "webhooks.on_member_add.method", + "url": "webhooks.on_member_add.url" + }, + "on_member_added": { + "format": "webhooks.on_member_added.format", + "method": "webhooks.on_member_added.method", + "url": "webhooks.on_member_added.url" + }, + "on_member_remove": { + "format": "webhooks.on_member_remove.format", + "method": "webhooks.on_member_remove.method", + "url": "webhooks.on_member_remove.url" + }, + "on_member_removed": { + "format": "webhooks.on_member_removed.format", + "method": "webhooks.on_member_removed.method", + "url": "webhooks.on_member_removed.url" + }, + "on_message_remove": { + "format": "webhooks.on_message_remove.format", + "method": "webhooks.on_message_remove.method", + "url": "webhooks.on_message_remove.url" + }, + "on_message_removed": { + "format": "webhooks.on_message_removed.format", + "method": "webhooks.on_message_removed.method", + "url": "webhooks.on_message_removed.url" + }, + "on_message_send": { + "format": "webhooks.on_message_send.format", + "method": "webhooks.on_message_send.method", + "url": "webhooks.on_message_send.url" + }, + "on_message_sent": { + "format": "webhooks.on_message_sent.format", + "method": "webhooks.on_message_sent.method", + "url": "webhooks.on_message_sent.url" + }, + "on_message_update": { + "format": "webhooks.on_message_update.format", + "method": "webhooks.on_message_update.method", + "url": "webhooks.on_message_update.url" + }, + "on_message_updated": { + "format": "webhooks.on_message_updated.format", + "method": "webhooks.on_message_updated.method", + "url": "webhooks.on_message_updated.url" + } + } + } + } } } }, @@ -3117,9 +3925,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3527,6 +4332,84 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Webhooks.OnChannelAdd.Format": "webhooks.on_channel_add.format", + "Webhooks.OnChannelAdd.Method": "webhooks.on_channel_add.method", + "Webhooks.OnChannelAdd.Url": "webhooks.on_channel_add.url", + "Webhooks.OnChannelAdded.Format": "webhooks.on_channel_added.format", + "Webhooks.OnChannelAdded.Method": "webhooks.on_channel_added.method", + "Webhooks.OnChannelAdded.Url": "webhooks.on_channel_added.url", + "Webhooks.OnChannelDestroy.Format": "webhooks.on_channel_destroy.format", + "Webhooks.OnChannelDestroy.Method": "webhooks.on_channel_destroy.method", + "Webhooks.OnChannelDestroy.Url": "webhooks.on_channel_destroy.url", + "Webhooks.OnChannelDestroyed.Format": "webhooks.on_channel_destroyed.format", + "Webhooks.OnChannelDestroyed.Method": "webhooks.on_channel_destroyed.method", + "Webhooks.OnChannelDestroyed.Url": "webhooks.on_channel_destroyed.url", + "Webhooks.OnChannelUpdate.Format": "webhooks.on_channel_update.format", + "Webhooks.OnChannelUpdate.Method": "webhooks.on_channel_update.method", + "Webhooks.OnChannelUpdate.Url": "webhooks.on_channel_update.url", + "Webhooks.OnChannelUpdated.Format": "webhooks.on_channel_updated.format", + "Webhooks.OnChannelUpdated.Method": "webhooks.on_channel_updated.method", + "Webhooks.OnChannelUpdated.Url": "webhooks.on_channel_updated.url", + "Webhooks.OnMemberAdd.Format": "webhooks.on_member_add.format", + "Webhooks.OnMemberAdd.Method": "webhooks.on_member_add.method", + "Webhooks.OnMemberAdd.Url": "webhooks.on_member_add.url", + "Webhooks.OnMemberAdded.Format": "webhooks.on_member_added.format", + "Webhooks.OnMemberAdded.Method": "webhooks.on_member_added.method", + "Webhooks.OnMemberAdded.Url": "webhooks.on_member_added.url", + "Webhooks.OnMemberRemove.Format": "webhooks.on_member_remove.format", + "Webhooks.OnMemberRemove.Method": "webhooks.on_member_remove.method", + "Webhooks.OnMemberRemove.Url": "webhooks.on_member_remove.url", + "Webhooks.OnMemberRemoved.Format": "webhooks.on_member_removed.format", + "Webhooks.OnMemberRemoved.Method": "webhooks.on_member_removed.method", + "Webhooks.OnMemberRemoved.Url": "webhooks.on_member_removed.url", + "Webhooks.OnMessageRemove.Format": "webhooks.on_message_remove.format", + "Webhooks.OnMessageRemove.Method": "webhooks.on_message_remove.method", + "Webhooks.OnMessageRemove.Url": "webhooks.on_message_remove.url", + "Webhooks.OnMessageRemoved.Format": "webhooks.on_message_removed.format", + "Webhooks.OnMessageRemoved.Method": "webhooks.on_message_removed.method", + "Webhooks.OnMessageRemoved.Url": "webhooks.on_message_removed.url", + "Webhooks.OnMessageSend.Format": "webhooks.on_message_send.format", + "Webhooks.OnMessageSend.Method": "webhooks.on_message_send.method", + "Webhooks.OnMessageSend.Url": "webhooks.on_message_send.url", + "Webhooks.OnMessageSent.Format": "webhooks.on_message_sent.format", + "Webhooks.OnMessageSent.Method": "webhooks.on_message_sent.method", + "Webhooks.OnMessageSent.Url": "webhooks.on_message_sent.url", + "Webhooks.OnMessageUpdate.Format": "webhooks.on_message_update.format", + "Webhooks.OnMessageUpdate.Method": "webhooks.on_message_update.method", + "Webhooks.OnMessageUpdate.Url": "webhooks.on_message_update.url", + "Webhooks.OnMessageUpdated.Format": "webhooks.on_message_updated.format", + "Webhooks.OnMessageUpdated.Method": "webhooks.on_message_updated.method", + "Webhooks.OnMessageUpdated.Url": "webhooks.on_message_updated.url" + } + } } } } @@ -3539,19 +4422,19 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -3561,6 +4444,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + } } } }, @@ -3573,9 +4492,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3591,6 +4507,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -3642,16 +4565,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3660,18 +4585,79 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "webhooks": {} + } + ] } } } @@ -3685,10 +4671,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { @@ -3697,18 +4680,18 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3741,6 +4724,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3752,10 +4757,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -3792,10 +4794,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -3828,6 +4827,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3840,9 +4861,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3866,6 +4884,15 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -3878,18 +4905,18 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3913,6 +4940,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3925,9 +4974,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3958,6 +5004,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4021,16 +5077,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4039,18 +5097,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + }, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -4064,10 +5169,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -4076,15 +5178,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "channel_sid", "status" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "list" }, "get": { "description": "", @@ -4153,16 +5255,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4171,18 +5275,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "links": { + "channel": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -4196,10 +5342,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } } }, @@ -4207,11 +5350,5 @@ { "url": "https://ip-messaging.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index 866a12b9..7be9b123 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "ip_messaging.v2.service.binding": { "type": "object", @@ -968,12 +974,6 @@ "muted" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -989,7 +989,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -999,15 +999,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "endpoint", "identity" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1090,16 +1090,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1108,18 +1110,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -1133,10 +1185,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { @@ -1145,15 +1194,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1189,6 +1238,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "user": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" + } + } + } } } }, @@ -1200,10 +1274,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", @@ -1243,10 +1314,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBinding" } }, "/v2/Services/{ServiceSid}/Channels/{Sid}": { @@ -1255,21 +1323,21 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}", "webhook": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1302,6 +1370,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" + }, + "examples": { + "fetch": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1313,10 +1407,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -1362,10 +1453,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -1407,6 +1495,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" + }, + "examples": { + "update": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1419,9 +1533,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1456,6 +1567,19 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1468,21 +1592,21 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "member": "{service_sid: service_sid, channel_sid: sid}", "message": "{service_sid: service_sid, channel_sid: sid}", "invite": "{service_sid: service_sid, channel_sid: sid}", "webhook": "{service_sid: service_sid, channel_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1515,6 +1639,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" + }, + "examples": { + "create": { + "value": { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "created_by": "username", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + } } } }, @@ -1527,9 +1677,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1569,6 +1716,19 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "CreatedBy": "username" + } + } } } } @@ -1644,16 +1804,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1662,17 +1824,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "unique_name": "unique_name", + "attributes": "{ \"foo\": \"bar\" }", + "type": "public", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:37Z", + "created_by": "system", + "members_count": 0, + "messages_count": 0, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", + "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", + "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "last_message": null + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" } } } @@ -1687,10 +1900,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { @@ -1699,14 +1909,14 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "configuration" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1775,16 +1985,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1793,18 +2005,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 5, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "webhooks" + }, + "webhooks": [] } } } @@ -1818,10 +2110,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelWebhook" }, "post": { "description": "", @@ -1854,6 +2143,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "webhook", + "configuration": { + "url": "dummy", + "method": "GET", + "filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "retry_count": 2 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1866,9 +2178,6 @@ } ], "operationId": "CreateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1919,6 +2228,20 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "webhook", + "Configuration.Url": "dummy", + "Configuration.Method": "GET", + "Configuration.Filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "Configuration.RetryCount": 2 + } + } } } } @@ -1931,14 +2254,14 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "configuration" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1983,6 +2306,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "studio", + "configuration": { + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1994,10 +2334,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannelWebhook" }, "post": { "description": "", @@ -2042,6 +2379,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "trigger", + "configuration": { + "url": "dummy", + "method": "POST", + "filters": [ + "keyword1", + "keyword2" + ], + "retry_count": 3 + }, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2054,9 +2414,6 @@ } ], "operationId": "UpdateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2099,6 +2456,19 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "dummy", + "Configuration.Method": "POST", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ], + "Configuration.RetryCount": 5 + } + } } } } @@ -2151,10 +2521,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { @@ -2163,7 +2530,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2218,16 +2585,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2236,17 +2605,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -2261,10 +2669,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -2274,6 +2679,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2286,9 +2705,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2329,6 +2745,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -2341,7 +2764,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2372,6 +2795,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2383,10 +2820,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -2410,6 +2844,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2422,9 +2870,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2457,6 +2902,13 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -2488,10 +2940,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -2500,15 +2949,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2553,6 +3002,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.invite" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2564,10 +3029,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -2616,10 +3078,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -2628,15 +3087,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2669,6 +3128,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.invite" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2681,9 +3156,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2706,6 +3178,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2744,6 +3224,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -2789,16 +3281,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2807,17 +3301,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "invites": [], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "invites": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "identity": "identity", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0", + "key": "invites", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0" } } } @@ -2832,10 +3367,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -2844,15 +3376,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2894,6 +3426,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" + }, + "examples": { + "fetch": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2905,10 +3455,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -2963,10 +3510,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -3017,6 +3561,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" + }, + "examples": { + "updateRoleSid": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": 20, + "last_consumption_timestamp": "2016-03-24T21:05:52Z", + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:51Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3029,9 +3591,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3071,6 +3630,18 @@ "description": "" } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DateCreated": "2016-03-24T21:05:50Z", + "DateUpdated": "2016-03-24T21:05:51Z", + "LastConsumedMessageIndex": 20, + "LastConsumptionTimestamp": "2016-03-24T21:05:52Z", + "Attributes": "{}" + } + } } } } @@ -3083,15 +3654,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3133,6 +3704,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" + }, + "examples": { + "create": { + "value": { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3145,9 +3734,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3194,6 +3780,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio", + "Attributes": "{}" + } + } } } } @@ -3277,16 +3871,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3295,18 +3891,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [ + { + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "last_consumed_message_index": null, + "last_consumption_timestamp": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "attributes": "{}", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", + "next_page_url": null, + "key": "members" + }, + "members": [] } } } @@ -3320,10 +3959,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -3332,7 +3968,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3340,8 +3976,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3386,6 +4022,53 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" + }, + "examples": { + "fetch": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3397,10 +4080,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -3458,10 +4138,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -3515,6 +4192,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" + }, + "examples": { + "update": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{ \"foo\": \"bar\" }", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "fromUser", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3527,9 +4226,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3564,6 +4260,18 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Attributes": "{ \"foo\": \"bar\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username", + "From": "fromUser" + } + } } } } @@ -3576,7 +4284,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3584,8 +4292,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3627,6 +4335,73 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" + }, + "examples": { + "create": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithAll": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-12-16T22:18:37Z", + "date_updated": "2015-12-16T22:18:38Z", + "last_updated_by": "username", + "was_edited": true, + "from": "system", + "attributes": "{\"test\": \"test\"}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createMedia": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": null, + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": "system", + "was_edited": false, + "from": "system", + "body": "Hello", + "index": 0, + "type": "text", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3639,9 +4414,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3683,6 +4455,27 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAll": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "LastUpdatedBy": "username" + } + }, + "createMedia": { + "value": { + "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3764,16 +4557,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3782,18 +4577,88 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [ + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "text", + "media": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-03-24T20:37:57Z", + "date_updated": "2016-03-24T20:37:57Z", + "last_updated_by": null, + "was_edited": false, + "from": "system", + "attributes": "{}", + "body": "Hello", + "index": 0, + "type": "media", + "media": { + "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 99999999999999, + "content_type": "application/pdf", + "filename": "hello.pdf" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", + "next_page_url": null, + "key": "messages" + }, + "messages": [] } } } @@ -3807,10 +4672,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v2/Services/{ServiceSid}/Roles/{Sid}": { @@ -3819,15 +4681,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3863,6 +4725,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" + }, + "examples": { + "fetch": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3874,10 +4756,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -3917,10 +4796,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -3956,6 +4832,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" + }, + "examples": { + "update": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3968,9 +4864,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3989,6 +4882,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -4001,15 +4901,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4033,6 +4933,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" + }, + "examples": { + "create": { + "value": { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4045,9 +4965,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4077,6 +4994,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -4140,16 +5066,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4158,18 +5086,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [ + { + "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "channel user", + "type": "channel", + "permissions": [ + "sendMessage", + "leaveChannel", + "editOwnMessage", + "deleteOwnMessage" + ], + "date_created": "2016-03-03T19:47:15Z", + "date_updated": "2016-03-03T19:47:15Z", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", + "next_page_url": null, + "key": "roles" + }, + "roles": [] } } } @@ -4183,10 +5156,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v2/Services/{Sid}": { @@ -4195,20 +5165,20 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}", "binding": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -4232,6 +5202,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4243,10 +5255,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -4274,10 +5283,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -4301,6 +5307,67 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 500, + "user_channels": 600 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": { + "log_enabled": true, + "added_to_channel": { + "enabled": false, + "template": "notifications.added_to_channel.template" + }, + "invited_to_channel": { + "enabled": false, + "template": "notifications.invited_to_channel.template" + }, + "new_message": { + "enabled": false, + "template": "notifications.new_message.template", + "badge_count_enabled": true + }, + "removed_from_channel": { + "enabled": false, + "template": "notifications.removed_from_channel.template" + } + }, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "new media compatibility message" + } + } + } } } }, @@ -4313,9 +5380,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4471,6 +5535,41 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "ConsumptionReportInterval": 100, + "DefaultChannelCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChannelRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Notifications.AddedToChannel.Enabled": false, + "Notifications.AddedToChannel.Template": "notifications.added_to_channel.template", + "Notifications.InvitedToChannel.Enabled": false, + "Notifications.InvitedToChannel.Template": "notifications.invited_to_channel.template", + "Notifications.NewMessage.Enabled": false, + "Notifications.NewMessage.Template": "notifications.new_message.template", + "Notifications.NewMessage.BadgeCountEnabled": true, + "Notifications.RemovedFromChannel.Enabled": false, + "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", + "Notifications.LogEnabled": true, + "Limits.ChannelMembers": 600, + "Limits.UserChannels": 500, + "PostWebhookUrl": "post_webhook_url", + "PreWebhookUrl": "pre_webhook_url", + "PreWebhookRetryCount": 2, + "PostWebhookRetryCount": 3, + "ReachabilityEnabled": false, + "ReadStatusEnabled": false, + "TypingIndicatorTimeout": 100, + "WebhookFilters": [ + "webhook_filters" + ], + "WebhookMethod": "webhook_method", + "Media.CompatibilityMessage": "new media compatibility message" + } + } } } } @@ -4483,20 +5582,20 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channel": "{service_sid: sid}", "role": "{service_sid: sid}", "user": "{service_sid: sid}", "binding": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -4506,6 +5605,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + } } } }, @@ -4518,9 +5659,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4536,6 +5674,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -4587,16 +5732,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4605,18 +5752,85 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "consumption_report_interval": 100, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "limits": { + "channel_members": 100, + "user_channels": 250 + }, + "links": { + "channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", + "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", + "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "notifications": {}, + "post_webhook_url": "post_webhook_url", + "pre_webhook_url": "pre_webhook_url", + "pre_webhook_retry_count": 2, + "post_webhook_retry_count": 3, + "reachability_enabled": false, + "read_status_enabled": false, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "typing_indicator_timeout": 100, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_filters": [ + "webhook_filters" + ], + "webhook_method": "webhook_method", + "media": { + "size_limit_mb": 150, + "compatibility_message": "media compatibility message" + } + } + ] } } } @@ -4630,10 +5844,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { @@ -4642,7 +5853,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4650,12 +5861,12 @@ "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}", "user_binding": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4688,6 +5899,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" + }, + "examples": { + "fetch": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4699,10 +5933,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -4739,10 +5970,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -4784,6 +6012,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" + }, + "examples": { + "update": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4796,9 +6047,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4822,6 +6070,15 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4834,7 +6091,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4842,12 +6099,12 @@ "identity", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channel": "{service_sid: service_sid, user_sid: sid}", "user_binding": "{service_sid: service_sid, user_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4880,6 +6137,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" + }, + "examples": { + "create": { + "value": { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "joined_channels_count": 0, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4892,9 +6172,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4925,6 +6202,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4988,16 +6275,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5006,18 +6295,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [ + { + "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "jing", + "attributes": null, + "is_online": true, + "is_notifiable": null, + "friendly_name": null, + "date_created": "2016-03-24T21:05:19Z", + "date_updated": "2016-03-24T21:05:19Z", + "joined_channels_count": 0, + "links": { + "user_channels": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" + }, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", + "next_page_url": null, + "key": "users" + }, + "users": [] } } } @@ -5031,10 +6368,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { @@ -5043,7 +6377,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5051,9 +6385,9 @@ "identity", "binding_type" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "list" }, "get": { "description": "", @@ -5134,16 +6468,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5152,18 +6488,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [ + { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", + "next_page_url": null, + "key": "bindings" + }, + "bindings": [] } } } @@ -5177,10 +6561,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { @@ -5189,7 +6570,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5197,9 +6578,9 @@ "identity", "binding_type" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "instance" }, "get": { "description": "", @@ -5244,6 +6625,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_binding" + }, + "examples": { + "fetch": { + "value": { + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-10-21T11:37:03Z", + "date_updated": "2016-10-21T11:37:03Z", + "endpoint": "TestUser-endpoint", + "identity": "TestUser", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "binding_type": "gcm", + "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "message_types": [ + "removed_from_channel", + "new_message", + "added_to_channel", + "invited_to_channel" + ], + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5255,10 +6659,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserBinding" }, "delete": { "description": "", @@ -5307,10 +6708,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -5319,15 +6717,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "channel_sid", "status" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "list" }, "get": { "description": "", @@ -5396,16 +6794,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5414,18 +6814,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "next_page_url": null, + "key": "channels" + }, + "channels": [] } } } @@ -5439,10 +6884,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { @@ -5451,15 +6893,15 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "channel_sid", "status" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "instance" }, "get": { "description": "", @@ -5501,6 +6943,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_channel" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "default", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5512,10 +6974,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserChannel" }, "delete": { "description": "", @@ -5561,10 +7020,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserChannel" }, "post": { "description": "", @@ -5606,6 +7062,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_channel" + }, + "examples": { + "updateNotificationLevel": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 5, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "joined", + "last_consumed_message_index": 10, + "unread_messages_count": 5, + "notification_level": "muted", + "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5618,9 +7112,6 @@ } ], "operationId": "UpdateUserChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5644,6 +7135,18 @@ "description": "" } } + }, + "examples": { + "updateNotificationLevel": { + "value": { + "NotificationLevel": "muted" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 10 + } + } } } } @@ -5655,11 +7158,5 @@ { "url": "https://ip-messaging.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_lookups_bulk.json b/spec/json/twilio_lookups_bulk.json new file mode 100644 index 00000000..1c80ea9c --- /dev/null +++ b/spec/json/twilio_lookups_bulk.json @@ -0,0 +1,447 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Lookup", + "termsOfService": "https://www.twilio.com/legal/tos", + "version": "1.0.0-alpha.1", + "description": "Lookup APIs for individual, bulk and job based requests\n\nDiscussion topics:\n- API version to use\n- Using or not lookup in the path or just as lookups subdomain", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "servers": [ + { + "url": "https://lookups.twilio.com" + } + ], + "paths": { + "/v2/batch/query": { + "post": { + "summary": "In Request Bulk", + "operationId": "post-bulkLookup", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LookupResponseWithCorId" + } + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "LookupRequest", + "properties": { + "LookupRequests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LookupRequestWithCorId" + } + } + } + } + } + } + }, + "description": "Discussions made regarding how to help the customer to correlation request and response objects:\n- Respecting the natural order (requests vs. response)\n- Using phone numbers as unique key\n- Adding a correlation_id key", + "security": [ + { + "accountSid_authToken": [] + } + ], + "parameters": [] + } + } + }, + "components": { + "schemas": { + "LookupRequest": { + "title": "Lookup request", + "type": "object", + "properties": { + "phone_number": { + "type": "string" + }, + "fields": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "caller_name", + "sim_swap", + "call_forwarding", + "live_activity", + "line_type_intelligence", + "identity_match", + "reassigned_number" + ] + } + }, + "country_code": { + "type": "string" + }, + "identity_match": { + "$ref": "#/components/schemas/IdentityMatchParameters" + }, + "reassigned_number": { + "$ref": "#/components/schemas/ReassignedNumberRequest" + } + }, + "required": [ + "phone_number" + ], + "description": "" + }, + "LookupRequestWithCorId": { + "title": "LookupRequestWithCorId", + "allOf": [ + { + "$ref": "#/components/schemas/LookupRequest" + } + ], + "type": "object", + "properties": { + "correlation_id": { + "type": "string", + "description": "Unique identifier used to match request with response" + } + } + }, + "LookupResponse": { + "title": "LookupResponse", + "type": "object", + "properties": { + "calling_country_code": { + "type": "string" + }, + "country_code": { + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "national_format": { + "type": "string" + }, + "valid": { + "type": "boolean" + }, + "validation_errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "caller_name": { + "$ref": "#/components/schemas/CallerName" + }, + "sim_swap": { + "$ref": "#/components/schemas/SimSwap" + }, + "call_forwarding": { + "$ref": "#/components/schemas/CallForwarding" + }, + "live_activity": { + "$ref": "#/components/schemas/LiveActivity" + }, + "line_type_intelligence": { + "$ref": "#/components/schemas/LineTypeIntelligence" + }, + "identity_match": { + "$ref": "#/components/schemas/IdentityMatch" + }, + "reassigned_number": { + "$ref": "#/components/schemas/ReassignedNumberResponse" + } + } + }, + "LookupResponseWithCorId": { + "allOf": [ + { + "$ref": "#/components/schemas/LookupResponse" + } + ], + "type": "object", + "properties": { + "correlation_id": { + "type": "string", + "description": "Unique identifier used to match request with response" + }, + "twilio_error_code": { + "type": "integer", + "description": "Twilio error conde in case that the request to downstream fails" + } + } + }, + "CallerName": { + "title": "CallerName", + "type": "object", + "properties": { + "caller_name": { + "type": "string" + }, + "caller_type": { + "type": "string" + }, + "error_code": { + "type": "integer" + } + } + }, + "SimSwap": { + "title": "SimSwap", + "allOf": [ + { + "$ref": "#/components/schemas/ATOCarrier" + } + ], + "properties": { + "last_sim_swap": { + "$ref": "#/components/schemas/LastSimSwap" + }, + "error_code": { + "type": "integer" + } + }, + "type": "object" + }, + "LastSimSwap": { + "title": "SimSwap", + "properties": { + "last_sim_swap_date": { + "type": "string", + "format": "date-time" + }, + "swapped_period": { + "type": "string" + }, + "swapped_in_period": { + "type": "boolean" + } + } + }, + "CallForwarding": { + "title": "CallForwarding", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ATOCarrier" + } + ], + "properties": { + "call_forwarding_enabled": { + "type": "boolean" + }, + "error_code": { + "type": "integer" + } + } + }, + "ATOCarrier": { + "title": "ATOCarrier", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/Carrier" + } + ], + "properties": { + "carrier_name": { + "type": "string" + } + } + }, + "LiveActivity": { + "title": "LiveActivity", + "type": "object", + "properties": { + "connectivity": { + "type": "string" + }, + "original_carrier": { + "$ref": "#/components/schemas/LiveActivityCarrier" + }, + "ported": { + "type": "string" + }, + "ported_carrier": { + "$ref": "#/components/schemas/LiveActivityCarrier" + }, + "roaming": { + "type": "string" + }, + "roaming_carrier": { + "$ref": "#/components/schemas/LiveActivityCarrier" + }, + "error_code": { + "type": "integer" + } + } + }, + "LiveActivityCarrier": { + "title": "LiveActivityCarrier", + "allOf": [ + { + "$ref": "#/components/schemas/Carrier" + } + ], + "properties": { + "name": { + "type": "string" + }, + "country": { + "type": "string" + } + }, + "type": "object" + }, + "LineTypeIntelligence": { + "title": "Packages/LineTypeIntelligence", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ATOCarrier" + } + ], + "properties": { + "type": { + "type": "string" + }, + "error_code": { + "type": "integer" + } + } + }, + "Carrier": { + "title": "Carrier", + "type": "object", + "properties": { + "mobile_country_code": { + "type": "string" + }, + "mobile_network_code": { + "type": "string" + } + } + }, + "IdentityMatch": { + "title": "IdentityMatch", + "type": "object", + "properties": { + "first_name_match": { + "type": "string" + }, + "last_name_match": { + "type": "string" + }, + "address_line_match": { + "type": "string" + }, + "city_match": { + "type": "string" + }, + "state_match": { + "type": "string" + }, + "postal_code_match": { + "type": "string" + }, + "country_code_match": { + "type": "string" + }, + "national_id_match": { + "type": "string" + }, + "date_of_birth_match": { + "type": "string" + }, + "summary_score": { + "type": "integer" + }, + "error_code": { + "type": "integer" + }, + "error_message": { + "type": "string" + } + } + }, + "IdentityMatchParameters": { + "title": "IdentityMatchParameters", + "type": "object", + "properties": { + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "address_line1": { + "type": "string" + }, + "address_line2": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "address_country_code": { + "type": "string" + }, + "national_id": { + "type": "string" + }, + "date_of_birth": { + "type": "string" + } + } + }, + "ReassignedNumberRequest": { + "title": "ReassignedNumberRequest", + "type": "object", + "properties": { + "last_verified_date": { + "type": "string" + } + } + }, + "ReassignedNumberResponse": { + "title": "ReassignedNumberResponse", + "type": "object", + "properties": { + "last_verified_date": { + "type": "string" + }, + "status": { + "type": "string" + }, + "error_code": { + "type": "string" + } + } + } + }, + "requestBodies": {} + } +} \ No newline at end of file diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index 9e56a2a9..83a6c7b6 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "lookups.v1.phone_number": { "type": "object", @@ -48,12 +54,6 @@ "voip" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -69,7 +69,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -107,6 +107,26 @@ "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.", "schema": { "type": "string" + }, + "examples": { + "fetchCarrier": { + "value": "country_code" + }, + "fetchCarrierInternational": { + "value": "country_code" + }, + "fetchCallerName": { + "value": "country_code" + }, + "fetchCarrierAndCallerName": { + "value": "country_code" + }, + "fetchAddonsWhitepagesPro": { + "value": "country_code" + }, + "fetchAddonsPayfone": { + "value": "country_code" + } } }, { @@ -118,6 +138,47 @@ "items": { "type": "string" } + }, + "examples": { + "fetch": { + "value": [] + }, + "fetchCarrier": { + "value": [ + "carrier" + ] + }, + "fetchCarrierInternational": { + "value": [ + "carrier" + ] + }, + "fetchCallerName": { + "value": [ + "caller-name" + ] + }, + "fetchCarrierAndCallerName": { + "value": [ + "carrier", + "caller-name" + ] + }, + "fetchAddonsWhitepagesPro": { + "value": [ + "caller-name" + ] + }, + "fetchAddonsNomorobo": { + "value": [ + "carrier" + ] + }, + "fetchAddonsPayfone": { + "value": [ + "carrier" + ] + } } }, { @@ -129,6 +190,23 @@ "items": { "type": "string" } + }, + "examples": { + "fetchAddonsWhitepagesPro": { + "value": [ + "whitepages_pro_caller_id" + ] + }, + "fetchAddonsNomorobo": { + "value": [ + "nomorobo_spamscore" + ] + }, + "fetchAddonsPayfone": { + "value": [ + "payfone_tcpa_compliance" + ] + } } }, { @@ -147,6 +225,239 @@ "application/json": { "schema": { "$ref": "#/components/schemas/lookups.v1.phone_number" + }, + "examples": { + "fetch": { + "value": { + "caller_name": null, + "carrier": null, + "fraud": null, + "add_ons": null, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchCarrier": { + "value": { + "caller_name": null, + "carrier": { + "error_code": null, + "mobile_country_code": "310", + "mobile_network_code": "456", + "name": "verizon", + "type": "mobile" + }, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "fraud": null, + "add_ons": null, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchCarrierInternational": { + "value": { + "caller_name": null, + "carrier": { + "error_code": null, + "mobile_country_code": null, + "mobile_network_code": null, + "name": "Vodafone Business Solutions", + "type": "landline" + }, + "country_code": "GB", + "national_format": "020 7765 1182", + "phone_number": "+4402077651182", + "fraud": null, + "add_ons": null, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+4402077651182" + } + }, + "fetchCallerName": { + "value": { + "caller_name": { + "caller_name": "Delicious Cheese Cake", + "caller_type": "CONSUMER", + "error_code": null + }, + "carrier": null, + "fraud": null, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "add_ons": null, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchCarrierAndCallerName": { + "value": { + "caller_name": { + "caller_name": "Delicious Cheese Cake", + "caller_type": "CONSUMER", + "error_code": null + }, + "carrier": { + "error_code": null, + "mobile_country_code": "310", + "mobile_network_code": "456", + "name": "verizon", + "type": "mobile" + }, + "fraud": null, + "country_code": "US", + "national_format": "(510) 867-5310", + "phone_number": "+15108675310", + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": {} + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310" + } + }, + "fetchAddonsWhitepagesPro": { + "value": { + "caller_name": { + "caller_name": "EMPIRE STATE BUILDING", + "caller_type": "BUSINESS", + "error_code": null + }, + "country_code": "US", + "phone_number": "+12127363100", + "national_format": "(212) 736-3100", + "carrier": null, + "fraud": null, + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": { + "whitepages_pro_caller_id": { + "status": "successful", + "request_sid": "XR28b8f152ae12345605b0b3cc34123456", + "message": null, + "code": null, + "result": { + "phone_number": "2127363100", + "warnings": [], + "historical_addresses": [], + "alternate_phones": [], + "error": null, + "is_commercial": true, + "associated_people": [], + "country_calling_code": "1", + "belongs_to": [], + "is_valid": true, + "line_type": "NonFixedVOIP", + "carrier": "Level 3 Communications", + "current_addresses": [ + { + "city": "New York", + "lat_long": { + "latitude": 40.748731, + "longitude": -73.986413, + "accuracy": "RoofTop" + }, + "is_active": null, + "location_type": "Address", + "street_line_2": null, + "link_to_person_start_date": "2018-08-28", + "street_line_1": "350 5th Ave", + "postal_code": "10118", + "delivery_point": "MultiUnit", + "country_code": "US", + "state_code": "NY", + "id": "Location.4e81b857-1234-5678-31d29a3301e1", + "zip4": "0110" + } + ], + "id": "Phone.f8396fef-1234-5678-bc7128b6fd99", + "is_prepaid": false + } + } + } + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+12127363100" + } + }, + "fetchAddonsNomorobo": { + "value": { + "caller_name": null, + "country_code": "US", + "phone_number": "+19892008374", + "national_format": "(989) 200-8374", + "carrier": { + "mobile_country_code": "310", + "mobile_network_code": null, + "name": "Ytel/Blitz", + "type": "mobile", + "error_code": null + }, + "fraud": null, + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": { + "nomorobo_spamscore": { + "status": "successful", + "request_sid": "XR763c8acc4c56d5e3e18d2f0f12345bc1", + "message": null, + "code": null, + "result": { + "status": "success", + "message": "success", + "score": 1 + } + } + } + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+19892008374" + } + }, + "fetchAddonsPayfone": { + "value": { + "caller_name": null, + "country_code": "US", + "phone_number": "+16502530000", + "national_format": "(650) 253-0000", + "carrier": { + "mobile_country_code": null, + "mobile_network_code": null, + "name": "Level 3 Communications, LLC", + "type": "landline", + "error_code": null + }, + "fraud": null, + "add_ons": { + "status": "successful", + "message": null, + "code": null, + "results": { + "payfone_tcpa_compliance": { + "status": "successful", + "request_sid": "XRd3a2991c9108bde3ca9589ed84d31463", + "message": null, + "code": null, + "result": { + "Status": 0, + "Response": { + "MSISDNType": "NonFixedVoIP", + "NumberMatch": "I", + "VerifyNumberTransactionId": "2019459819" + }, + "RequestId": "XRd3a2991c9108bde3ca9589ed84d31463", + "Description": "Success." + } + } + } + }, + "url": "https://lookups.twilio.com/v1/PhoneNumbers/+16502530000" + } + } } } }, @@ -158,10 +469,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" } } }, @@ -169,11 +477,5 @@ { "url": "https://lookups.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_lookups_v2.json b/spec/json/twilio_lookups_v2.json index bd24c036..ba12514d 100644 --- a/spec/json/twilio_lookups_v2.json +++ b/spec/json/twilio_lookups_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "lookups.v2.phone_number": { "type": "object", @@ -63,6 +69,10 @@ "nullable": true, "description": "An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources" }, + "reassigned_number": { + "nullable": true, + "description": "An object that contains reassigned number information. Reassigned Numbers will return a phone number's reassignment status given a phone number and date" + }, "sms_pumping_risk": { "nullable": true, "description": "An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates." @@ -94,12 +104,6 @@ "NOT_A_NUMBER" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -115,7 +119,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -151,9 +155,56 @@ { "name": "Fields", "in": "query", - "description": "A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.", + "description": "A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match, reassigned_number.", "schema": { "type": "string" + }, + "examples": { + "fetchCallerName": { + "value": "caller_name" + }, + "fetchSimSwap": { + "value": "sim_swap" + }, + "fetchSimSwapWithoutLastSimSwapDate": { + "value": "sim_swap" + }, + "fetchSimSwapWithFalseSwapped": { + "value": "sim_swap" + }, + "fetchCallForwarding": { + "value": "call_forwarding" + }, + "fetchSimSwapAndCallForwarding": { + "value": "sim_swap,call_forwarding" + }, + "fetchLiveActivityConnectivity": { + "value": "live_activity" + }, + "fetchLiveActivityPorting": { + "value": "live_activity" + }, + "fetchLiveActivityRoaming": { + "value": "live_activity" + }, + "fetchLineTypeIntelligence": { + "value": "line_type_intelligence" + }, + "fetchIdentityMatch": { + "value": "identity_match" + }, + "fetchSmsPumpingRisk": { + "value": "sms_pumping_risk" + }, + "fetchReassignedNumberWithNumberReassigned": { + "value": "reassigned_number" + }, + "fetchReassignedNumberWithNumberNoReassigned": { + "value": "reassigned_number" + }, + "fetchReassignedNumberWithNoDataAvailable": { + "value": "reassigned_number" + } } }, { @@ -170,6 +221,11 @@ "description": "User\u2019s first name. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "John" + } } }, { @@ -178,6 +234,11 @@ "description": "User\u2019s last name. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "Doe" + } } }, { @@ -186,6 +247,11 @@ "description": "User\u2019s first address line. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "321 Main Street" + } } }, { @@ -194,6 +260,11 @@ "description": "User\u2019s second address line. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "Suite 2" + } } }, { @@ -202,6 +273,11 @@ "description": "User\u2019s city. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "New York" + } } }, { @@ -210,6 +286,11 @@ "description": "User\u2019s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "NY" + } } }, { @@ -218,6 +299,11 @@ "description": "User\u2019s postal zip code. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "10021" + } } }, { @@ -227,6 +313,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "fetchIdentityMatch": { + "value": "US" + } } }, { @@ -235,6 +326,11 @@ "description": "User\u2019s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "YZ3456883" + } } }, { @@ -243,6 +339,30 @@ "description": "User\u2019s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchIdentityMatch": { + "value": "19901214" + } + } + }, + { + "name": "LastVerifiedDate", + "in": "query", + "description": "The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.", + "schema": { + "type": "string" + }, + "examples": { + "fetchReassignedNumberWithNumberReassigned": { + "value": "20201227" + }, + "fetchReassignedNumberWithNumberNoReassigned": { + "value": "20190924" + }, + "fetchReassignedNumberWithNoDataAvailable": { + "value": "20211224" + } } } ], @@ -252,6 +372,478 @@ "application/json": { "schema": { "$ref": "#/components/schemas/lookups.v2.phone_number" + }, + "examples": { + "fetch": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchInvalid": { + "value": { + "calling_country_code": null, + "country_code": null, + "phone_number": "+141599299600", + "national_format": null, + "valid": false, + "validation_errors": [ + "TOO_LONG" + ], + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+141599299600" + } + }, + "fetchCallerName": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": null, + "caller_name": { + "caller_name": "Sergio Suarez", + "caller_type": "CONSUMER", + "error_code": null + }, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchSimSwap": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": { + "last_sim_swap": { + "last_sim_swap_date": "2020-04-27T10:18:50Z", + "swapped_period": "PT15282H33M44S", + "swapped_in_period": true + }, + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchSimSwapWithoutLastSimSwapDate": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": { + "last_sim_swap": { + "last_sim_swap_date": null, + "swapped_period": "PT24H", + "swapped_in_period": true + }, + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchSimSwapWithFalseSwapped": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": { + "last_sim_swap": { + "last_sim_swap_date": null, + "swapped_period": "PT24H", + "swapped_in_period": false + }, + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchCallForwarding": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": null, + "call_forwarding": { + "call_forwarding_status": "true", + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchSimSwapAndCallForwarding": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": { + "last_sim_swap": { + "last_sim_swap_date": "2020-11-05T20:52:09.322Z", + "swapped_period": "PT24H", + "swapped_in_period": true + }, + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "call_forwarding": { + "call_forwarding_status": "true", + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchLiveActivityConnectivity": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": { + "connectivity": "connected", + "original_carrier": { + "name": "Vodafone", + "mobile_country_code": "234", + "mobile_network_code": "15" + }, + "ported": "false", + "ported_carrier": null, + "roaming": "false", + "roaming_carrier": null, + "error_code": null + }, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchLiveActivityPorting": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": { + "connectivity": "connected", + "original_carrier": { + "name": "Vodafone", + "mobile_country_code": "234", + "mobile_network_code": "15" + }, + "ported": "true", + "ported_carrier": { + "name": "Orange", + "mobile_country_code": "266", + "mobile_network_code": "10" + }, + "roaming": "false", + "roaming_carrier": null, + "error_code": null + }, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchLiveActivityRoaming": { + "value": { + "calling_country_code": "44", + "country_code": "GB", + "phone_number": "+447772000001", + "national_format": "07772 000001", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": { + "connectivity": "connected", + "original_carrier": { + "name": "Vodafone", + "mobile_country_code": "234", + "mobile_network_code": "15" + }, + "ported": "false", + "ported_carrier": null, + "roaming": "true", + "roaming_carrier": { + "name": "Orange", + "mobile_country_code": "266", + "mobile_network_code": "10", + "country_code": "RO" + }, + "error_code": null + }, + "line_type_intelligence": null, + "identity_match": null, + "sms_pumping_risk": null, + "reassigned_number": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchLineTypeIntelligence": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": null, + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": { + "error_code": null, + "mobile_country_code": "240", + "mobile_network_code": "38", + "carrier_name": "Twilio - SMS/MMS-SVR", + "type": "nonFixedVoip" + }, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchIdentityMatch": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": [], + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": { + "first_name_match": "exact_match", + "last_name_match": "high_partial_match", + "address_lines_match": "no_match", + "city_match": "no_match", + "state_match": "high_partial_match", + "postal_code_match": "no_data_available", + "address_country_match": "exact_match", + "national_id_match": "exact_match", + "date_of_birth_match": "exact_match", + "summary_score": 90, + "error_code": null, + "error_message": null + }, + "reassigned_number": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchSmsPumpingRisk": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": [], + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": { + "carrier": { + "name": "Twilio Carrier", + "mobile_country_code": "214", + "mobile_network_code": "07", + "carrier_risk_score": 69, + "carrier_risk_category": "moderate" + }, + "number_blocked": false, + "number_blocked_date": null, + "number_blocked_last_3_months": null, + "sms_pumping_risk_score": 61, + "error_code": null + }, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchReassignedNumberWithNumberReassigned": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": [], + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "reassigned_number": { + "last_verified_date": "2020-12-27", + "is_number_reassigned": "yes", + "error_code": null + }, + "identity_match": null, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchReassignedNumberWithNumberNoReassigned": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": [], + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": { + "last_verified_date": "2019-09-24", + "is_number_reassigned": "no", + "error_code": null + }, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchReassignedNumberWithNoDataAvailable": { + "value": { + "calling_country_code": "1", + "country_code": "US", + "phone_number": "+14159929960", + "national_format": "(415) 992-9960", + "valid": true, + "validation_errors": [], + "caller_name": null, + "sim_swap": null, + "call_forwarding": null, + "live_activity": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": { + "last_verified_date": "2021-12-24", + "is_number_reassigned": "no_data_available", + "error_code": null + }, + "sms_pumping_risk": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + } } } }, @@ -263,10 +855,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" } } }, @@ -274,11 +863,5 @@ { "url": "https://lookups.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_media_v1.json b/spec/json/twilio_media_v1.json index a32c5961..712ced55 100644 --- a/spec/json/twilio_media_v1.json +++ b/spec/json/twilio_media_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "media.v1.media_processor": { "type": "object", @@ -393,12 +399,31 @@ "description": "The grant that authorizes the player sdk to connect to the livestream" } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "transcription_enum_status": { + "type": "string", + "enum": [ + "completed", + "deleted", + "enqueued", + "failed", + "processing" + ] + }, + "transcription_configuration_enum_method": { + "type": "string", + "enum": [ + "get", + "post" + ] + }, + "transcription_result_enum_format": { + "type": "string", + "enum": [ + "json", + "raw", + "txt" + ] } } }, @@ -415,7 +440,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -433,8 +458,8 @@ "extension", "extension_context" ], - "pathType": "list", - "mountName": "media_processor" + "mountName": "media_processor", + "pathType": "list" }, "post": { "description": "", @@ -444,6 +469,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_processor" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "started", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + } } } }, @@ -456,9 +499,6 @@ } ], "operationId": "CreateMediaProcessor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -504,6 +544,18 @@ "Extension", "ExtensionContext" ] + }, + "examples": { + "create": { + "value": { + "Extension": "video-composer-v2", + "ExtensionContext": "{}", + "ExtensionEnvironment": "{}", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "POST", + "MaxDuration": 300 + } + } } } } @@ -519,6 +571,20 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_processor_enum_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readItems": { + "value": "desc" + }, + "readItemsUsingPageToken": { + "value": "desc" + }, + "readItemsPageLargerThanMax": { + "value": "desc" + } } }, { @@ -528,6 +594,20 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_processor_enum_status" + }, + "examples": { + "readEmpty": { + "value": "started" + }, + "readItems": { + "value": "ended" + }, + "readItemsUsingPageToken": { + "value": "ended" + }, + "readItemsPageLargerThanMax": { + "value": "ended" + } } }, { @@ -573,16 +653,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -591,18 +673,119 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [] + } + }, + "readItems": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + ] + } + }, + "readItemsUsingPageToken": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0&PageToken=PTTUszYTgyOGFhNDIzZWExNzA0OTkwODNlMDlkZTg3M2NiNDoxOjI%253D", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + ] + } + }, + "readItemsPageLargerThanMax": { + "value": { + "meta": { + "page": 0, + "page_size": 100, + "first_page_url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0", + "next_page_url": null, + "key": "media_processors" + }, + "media_processors": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + ] } } } @@ -616,10 +799,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMediaProcessor", - "x-maturity": [ - "GA" - ] + "operationId": "ListMediaProcessor" } }, "/v1/MediaProcessors/{Sid}": { @@ -636,8 +816,8 @@ "extension", "extension_context" ], - "pathType": "instance", - "mountName": "media_processor" + "mountName": "media_processor", + "pathType": "instance" }, "get": { "description": "Returns a single MediaProcessor resource identified by a SID.", @@ -661,6 +841,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_processor" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "started", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + } } } }, @@ -672,10 +870,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMediaProcessor", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMediaProcessor" }, "post": { "description": "Updates a MediaProcessor resource identified by a SID.", @@ -699,6 +894,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_processor" + }, + "examples": { + "updateEnded": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "extension": "video-composer-v2", + "extension_context": "{}", + "sid": "ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "status": "ended", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef", + "max_duration": 300 + } + } } } }, @@ -711,9 +924,6 @@ } ], "operationId": "UpdateMediaProcessor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -730,6 +940,13 @@ "required": [ "Status" ] + }, + "examples": { + "updateEnded": { + "value": { + "Status": "ended" + } + } } } } @@ -748,12 +965,12 @@ "sid", "status" ], - "pathType": "instance", "dependentProperties": { - "media/v1/media_recording_timed_metadata": "{media_recording_sid: sid}", - "media/v1/media_recording_media": "{media_recording_sid: sid}" + "recording_timed_metadata": "{media_recording_sid: sid}", + "media_recording_media": "{media_recording_sid: sid}" }, - "mountName": "media_recording" + "mountName": "media_recording", + "pathType": "instance" }, "delete": { "description": "Deletes a MediaRecording resource identified by a SID.", @@ -781,10 +998,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMediaRecording", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteMediaRecording" }, "get": { "description": "Returns a single MediaRecording resource identified by a SID.", @@ -808,6 +1022,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.media_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "duration": 2147483647, + "format": "mp4", + "links": { + "media": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media", + "timed_metadata": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata" + }, + "processor_sid": "ZXcafebabecafebabecafebabecafebabe", + "resolution": "640x480", + "source_sid": "RMcafebabecafebabecafebabecafebabe", + "sid": "KVcafebabecafebabecafebabecafebabe", + "media_size": 2147483648, + "status": "completed", + "status_callback": "https://www.example.com", + "status_callback_method": "POST", + "url": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe" + } + } } } }, @@ -819,10 +1057,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMediaRecording", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMediaRecording" } }, "/v1/MediaRecordings": { @@ -837,12 +1072,12 @@ "sid", "status" ], - "pathType": "list", "dependentProperties": { - "media/v1/media_recording_timed_metadata": "{media_recording_sid: sid}", - "media/v1/media_recording_media": "{media_recording_sid: sid}" + "recording_timed_metadata": "{media_recording_sid: sid}", + "media_recording_media": "{media_recording_sid: sid}" }, - "mountName": "media_recording" + "mountName": "media_recording", + "pathType": "list" }, "get": { "description": "Returns a list of MediaRecordings.", @@ -854,6 +1089,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_recording_enum_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readItems": { + "value": "desc" + } } }, { @@ -863,6 +1106,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/media_recording_enum_status" + }, + "examples": { + "readEmpty": { + "value": "processing" + }, + "readItems": { + "value": "completed" + } } }, { @@ -874,6 +1125,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^ZX[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readItems": { + "value": "ZXcafebabecafebabecafebabecafebabe" + } } }, { @@ -885,6 +1144,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readItems": { + "value": "RMcafebabecafebabecafebabecafebabe" + } } }, { @@ -930,16 +1197,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -948,18 +1217,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_recordings" + }, + "media_recordings": [] + } + }, + "readItems": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0", + "next_page_url": null, + "key": "media_recordings" + }, + "media_recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "duration": 1000, + "format": "mp4", + "links": { + "media": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media", + "timed_metadata": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata" + }, + "processor_sid": "ZXcafebabecafebabecafebabecafebabe", + "resolution": "640x480", + "source_sid": "RMcafebabecafebabecafebabecafebabe", + "sid": "KVcafebabecafebabecafebabecafebabe", + "media_size": 1000, + "status": "completed", + "status_callback": "https://www.example.com", + "status_callback_method": "POST", + "url": "https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe" + } + ] } } } @@ -973,10 +1291,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMediaRecording", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMediaRecording" } }, "/v1/PlayerStreamers/{Sid}": { @@ -991,13 +1306,13 @@ "sid", "status" ], - "pathType": "instance", "dependentProperties": { - "media/v1/player_streamer_timed_metadata": "{player_streamer_sid: sid}", + "timed_metadata": "{player_streamer_sid: sid}", "playback_grant": "{sid: sid}", - "media/v1/player_streamer_recording_playback_grant": "{sid: sid}" + "recording_playback_grant": "{sid: sid}" }, - "mountName": "player_streamer" + "mountName": "player_streamer", + "pathType": "instance" }, "get": { "description": "Returns a single PlayerStreamer resource identified by a SID.", @@ -1021,6 +1336,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "created", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + } } } }, @@ -1032,10 +1368,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPlayerStreamer", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPlayerStreamer" }, "post": { "description": "Updates a PlayerStreamer resource identified by a SID.", @@ -1059,6 +1392,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "status": "ended", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + } } } }, @@ -1071,9 +1425,6 @@ } ], "operationId": "UpdatePlayerStreamer", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1090,6 +1441,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -1108,13 +1466,13 @@ "sid", "status" ], - "pathType": "list", "dependentProperties": { - "media/v1/player_streamer_timed_metadata": "{player_streamer_sid: sid}", + "timed_metadata": "{player_streamer_sid: sid}", "playback_grant": "{sid: sid}", - "media/v1/player_streamer_recording_playback_grant": "{sid: sid}" + "recording_playback_grant": "{sid: sid}" }, - "mountName": "player_streamer" + "mountName": "player_streamer", + "pathType": "list" }, "post": { "description": "", @@ -1124,6 +1482,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "created", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": null, + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + } } } }, @@ -1136,9 +1515,6 @@ } ], "operationId": "CreatePlayerStreamer", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1173,6 +1549,11 @@ "description": "The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming." } } + }, + "examples": { + "create": { + "value": {} + } } } } @@ -1188,6 +1569,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/player_streamer_enum_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readItems": { + "value": "desc" + }, + "readItemsPageLargerThanMax": { + "value": "desc" + } } }, { @@ -1197,6 +1589,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/player_streamer_enum_status" + }, + "examples": { + "readEmpty": { + "value": "started" + }, + "readItems": { + "value": "ended" + }, + "readItemsPageLargerThanMax": { + "value": "ended" + } } }, { @@ -1242,16 +1645,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1260,18 +1665,96 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0", + "next_page_url": null, + "key": "player_streamers" + }, + "player_streamers": [] + } + }, + "readItems": { + "value": { + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0", + "next_page_url": null, + "key": "player_streamers" + }, + "player_streamers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "status": "ended", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + ] + } + }, + "readItemsPageLargerThanMax": { + "value": { + "meta": { + "page": 0, + "page_size": 100, + "first_page_url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0", + "previous_page_url": null, + "url": "https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0", + "next_page_url": null, + "key": "player_streamers" + }, + "player_streamers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:00Z", + "status": "ended", + "video": true, + "sid": "VJcafebabecafebabecafebabecafebabe", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "ended_reason": "ended-via-api", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe", + "max_duration": 300, + "links": { + "timed_metadata": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata", + "playback_grant": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant" + } + } + ] } } } @@ -1285,10 +1768,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPlayerStreamer", - "x-maturity": [ - "GA" - ] + "operationId": "ListPlayerStreamer" } }, "/v1/PlayerStreamers/{Sid}/PlaybackGrant": { @@ -1300,8 +1780,8 @@ "description": "A PlaybackGrant resource allows developers to generate a grant to initialize the Twilio Live Player SDK and connect to a livestream.", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/PlayerStreamers/{Sid}" + "parent": "/PlayerStreamers/{Sid}", + "pathType": "instance" }, "post": { "description": "", @@ -1325,6 +1805,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant" + }, + "examples": { + "create": { + "value": { + "sid": "VJcafebabecafebabecafebabecafebabe", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "grant": { + "playbackUrl": "http://video.net/123/blabla?token=123", + "playerStreamerSid": "VJcafebabecafebabecafebabecafebabe", + "requestCredentials": null + } + } + } } } }, @@ -1337,9 +1832,6 @@ } ], "operationId": "CreatePlayerStreamerPlaybackGrant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1356,6 +1848,14 @@ "description": "The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 100, + "AccessControlAllowOrigin": "youraccess_control_allow_origin.com" + } + } } } } @@ -1383,6 +1883,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant", + "sid": "VJcafebabecafebabecafebabecafebabe", + "grant": { + "playbackUrl": "http://video.net/123/blabla?token=123", + "playerStreamerSid": "VJcafebabecafebabecafebabecafebabe", + "requestCredentials": null + } + } + } } } }, @@ -1394,10 +1909,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPlayerStreamerPlaybackGrant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPlayerStreamerPlaybackGrant" } } }, @@ -1405,15 +1917,5 @@ { "url": "https://media.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_messaging_bulk_v1.json b/spec/json/twilio_messaging_bulk_v1.json new file mode 100644 index 00000000..a21f93d0 --- /dev/null +++ b/spec/json/twilio_messaging_bulk_v1.json @@ -0,0 +1,271 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Bulk Messaging API", + "description": "This is the public Twilio REST API for 1:Many Message creation.", + "termsOfService": "https://www.twilio.com/legal/tos", + "version": "1.0.0-alpha.1", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "servers": [ + { + "url": "https://preview.messaging.twilio.com" + } + ], + "paths": { + "/v1/Messages": { + "post": { + "description": "Send messages to multiple recipients", + "operationId": "CreateMessages", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateMessagesRequest", + "properties": { + "Messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.Message" + } + }, + "From": { + "type": "string", + "format": "phone-number", + "description": "A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty." + }, + "MessagingServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery." + }, + "Body": { + "type": "string", + "description": "The text of the message you want to send. Can be up to 1,600 characters in length." + }, + "ContentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "description": "The SID of the preconfigured [Content Template](https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template) you want to associate with the Message. Must be used in conjuction with a preconfigured [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) When this parameter is set, Twilio will use your configured content template and the provided `ContentVariables`. This Twilio product is currently in Private Beta." + }, + "MediaUrl": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada." + }, + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "The URL we should call using the \"status_callback_method\" to send status information to your application. If specified, we POST these message status changes to the URL - queued, failed, sent, delivered, or undelivered. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/messaging/twiml#request-parameters) as well as some additional parameters including \"MessageSid\", \"MessageStatus\", and \"ErrorCode\". If you include this parameter with the \"messaging_service_sid\", we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api). URLs must contain a valid hostname and underscores are not allowed." + }, + "ValidityPeriod": { + "type": "integer", + "description": "How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds." + }, + "SendAt": { + "type": "string", + "description": "The time at which Twilio will send the message. This parameter can be used to schedule a message to be sent at a particular time. Must be in ISO 8601 format." + }, + "ScheduleType": { + "type": "string", + "description": "This parameter indicates your intent to schedule a message. Pass the value `fixed` to schedule a message at a fixed time. This parameter works in conjuction with the `SendAt` parameter." + }, + "ShortenUrls": { + "type": "boolean", + "description": "Determines the usage of Click Tracking. Setting it to `true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`." + }, + "SendAsMms": { + "type": "boolean", + "description": "If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media." + }, + "MaxPrice": { + "type": "number", + "description": "The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds max_price, the message will fail and a status of Failed is sent to the status callback. If MaxPrice is not set, the message cost is not checked." + }, + "Attempt": { + "type": "integer", + "description": "Total number of attempts made ( including this ) to send out the message regardless of the provider used" + }, + "SmartEncoded": { + "type": "boolean", + "description": "This parameter indicates whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be true or false." + }, + "ForceDelivery": { + "type": "boolean", + "description": "This parameter allows Twilio to send SMS traffic to carriers without checking/caring whether the destination number is a mobile or a landline." + }, + "ApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "The SID of the application that should receive message status. We POST a message_sid parameter and a message_status parameter with a value of sent or failed to the application's message_status_callback. If a status_callback parameter is also passed, it will be ignored and the application's message_status_callback parameter will be used." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.CreateMessagesResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.Error" + } + } + } + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ] + } + } + }, + "components": { + "schemas": { + "messaging.v1.Message": { + "type": "object", + "properties": { + "To": { + "type": "string", + "format": "phone-number", + "description": "The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels." + }, + "Body": { + "type": "string", + "description": "The text of the message you want to send. Can be up to 1,600 characters in length. Overrides the request-level body and content template if provided." + }, + "ContentVariables": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of variable names to substitution values. Refer to the [Twilio Content API Resources](https://www.twilio.com/docs/content-api/content-api-resources#send-a-message-with-preconfigured-content) for more details." + } + } + }, + "messaging.v1.MessageReceipt": { + "type": "object", + "properties": { + "to": { + "type": "string", + "nullable": true, + "description": "The recipient phone number" + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that identifies the resource" + } + } + }, + "messaging.v1.FailedMessageReceipt": { + "type": "object", + "properties": { + "to": { + "type": "string", + "description": "The recipient phone number" + }, + "error_message": { + "type": "string", + "description": "The description of the error_code" + }, + "error_code": { + "type": "integer", + "description": "The error code associated with the message creation attempt" + } + } + }, + "messaging.v1.CreateMessagesResult": { + "properties": { + "total_message_count": { + "type": "integer", + "description": "The number of Messages processed in the request, equal to the sum of success_count and error_count." + }, + "success_count": { + "type": "integer", + "description": "The number of Messages successfully created." + }, + "error_count": { + "type": "integer", + "description": "The number of Messages unsuccessfully processed in the request." + }, + "message_receipts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.MessageReceipt" + } + }, + "failed_message_receipts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messaging.v1.FailedMessageReceipt" + } + } + } + }, + "messaging.v1.Error": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The error message details" + }, + "code": { + "type": "integer", + "description": "The Twilio error code" + }, + "status": { + "type": "integer", + "description": "The HTTP status code" + }, + "more_info": { + "type": "string", + "description": "More information on the error" + } + } + } + }, + "securitySchemes": { + "accountSid_authToken": { + "type": "http", + "scheme": "basic" + } + } + } +} \ No newline at end of file diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index 942a9aa9..6bafef39 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "messaging.v1.service.alpha_sender": { "type": "object", @@ -882,6 +888,25 @@ } } }, + "tollfree_verification_enum_status": { + "type": "string", + "enum": [ + "PENDING_REVIEW", + "IN_REVIEW", + "TWILIO_APPROVED", + "TWILIO_REJECTED" + ] + }, + "tollfree_verification_enum_opt_in_type": { + "type": "string", + "enum": [ + "VERBAL", + "WEB_FORM", + "PAPER_FORM", + "VIA_TEXT", + "MOBILE_QR_CODE" + ] + }, "messaging.v1.service.us_app_to_person": { "type": "object", "properties": { @@ -1060,12 +1085,37 @@ "description": "Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases." } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "whatsapp_sender_enum_status": { + "type": "string", + "enum": [ + "Configuring", + "PendingVerification", + "Configured", + "ConfigurationError", + "VerificationError" + ] + }, + "whatsapp_template_enum_category": { + "type": "string", + "enum": [ + "ACCOUNT_UPDATE", + "ALERT_UPDATE", + "AUTO_REPLY", + "APPOINTMENT_UPDATE", + "ISSUE_RESOLUTION", + "PAYMENT_UPDATE", + "PERSONAL_FINANCE_UPDATE", + "RESERVATION_UPDATE", + "SHIPPING_UPDATE", + "TICKET_UPDATE", + "TRANSPORTATION_UPDATE", + "MARKETING", + "OTP", + "TRANSACTIONAL", + "AUTHENTICATION", + "UTILITY" + ] } } }, @@ -1082,7 +1132,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1098,8 +1148,8 @@ "sid", "alpha_sender" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1123,6 +1173,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.alpha_sender" + }, + "examples": { + "create": { + "value": { + "sid": "AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "alpha_sender": "Twilio", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1135,9 +1201,6 @@ } ], "operationId": "CreateAlphaSender", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1153,6 +1216,13 @@ "required": [ "AlphaSender" ] + }, + "examples": { + "create": { + "value": { + "AlphaSender": "Twilio" + } + } } } } @@ -1216,16 +1286,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1234,18 +1306,45 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "alpha_senders", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0" + }, + "alpha_senders": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "alpha_sender": "Twilio", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -1259,10 +1358,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAlphaSender" } }, "/v1/Services/{ServiceSid}/AlphaSenders/{Sid}": { @@ -1277,8 +1373,8 @@ "sid", "alpha_sender" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1311,6 +1407,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.alpha_sender" + }, + "examples": { + "fetch": { + "value": { + "sid": "AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "alpha_sender": "Twilio", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1322,10 +1434,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAlphaSender" }, "delete": { "description": "", @@ -1362,10 +1471,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAlphaSender" } }, "/v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp": { @@ -1380,9 +1486,9 @@ "account_sid", "brand_registration_sid" ], - "pathType": "list", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_registration_otps" + "mountName": "brand_registration_otps", + "pathType": "list" }, "post": { "description": "", @@ -1406,6 +1512,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_registration_otp" + }, + "examples": { + "create": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_registration_sid": "BN0044409f7e067e279523808d267e2d85" + } + } } } }, @@ -1417,10 +1531,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateBrandRegistrationOtp", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateBrandRegistrationOtp" } }, "/v1/a2p/BrandRegistrations/{Sid}": { @@ -1435,11 +1546,11 @@ "sid", "date_created" ], - "pathType": "instance", "dependentProperties": { "brand_vetting": "{brand_sid: sid}", "brand_registration_otp": "{brand_registration_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1463,6 +1574,146 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations" + }, + "examples": { + "fetch": { + "value": { + "sid": "BN0044409f7e067e279523808d267e2d85", + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "brand_type": "STANDARD", + "status": "PENDING", + "tcr_id": "BXXXXXX", + "failure_reason": "Registration error", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85", + "brand_score": 42, + "brand_feedback": [ + "TAX_ID", + "NONPROFIT" + ], + "identity_status": "VERIFIED", + "russell_3000": true, + "government_entity": false, + "tax_exempt_status": "501c3", + "skip_automatic_sec_vet": false, + "mock": false, + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp" + } + } + }, + "fetchSoleProprietorPending": { + "value": { + "sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "a2p_profile_bundle_sid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "customer_profile_bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "PENDING", + "identity_status": null, + "brand_type": "SOLE_PROPRIETOR", + "mock": false, + "tcr_id": null, + "brand_score": null, + "russell_3000": null, + "brand_feedback": null, + "failure_reason": null, + "government_entity": null, + "tax_exempt_status": null, + "skip_automatic_sec_vet": false, + "date_updated": "2023-03-15T14:21:42Z", + "date_created": "2023-03-15T14:21:42Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp" + } + } + }, + "fetchSoleProprietorRegisteredUnverified": { + "value": { + "sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "a2p_profile_bundle_sid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "customer_profile_bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "APPROVED", + "identity_status": "UNVERIFIED", + "brand_type": "SOLE_PROPRIETOR", + "mock": false, + "tcr_id": null, + "brand_score": null, + "russell_3000": null, + "brand_feedback": null, + "failure_reason": null, + "government_entity": null, + "tax_exempt_status": null, + "skip_automatic_sec_vet": false, + "date_updated": "2023-03-15T14:21:42Z", + "date_created": "2023-03-15T14:21:42Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp" + } + } + }, + "fetchSoleProprietorRegisteredSelfDeclared": { + "value": { + "sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "a2p_profile_bundle_sid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "customer_profile_bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "APPROVED", + "identity_status": "SELF_DECLARED", + "brand_type": "SOLE_PROPRIETOR", + "mock": false, + "tcr_id": null, + "brand_score": null, + "russell_3000": null, + "brand_feedback": null, + "failure_reason": null, + "government_entity": null, + "tax_exempt_status": null, + "skip_automatic_sec_vet": false, + "date_updated": "2023-03-15T14:21:42Z", + "date_created": "2023-03-15T14:21:42Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp" + } + } + }, + "fetchSoleProprietorRegisteredVerified": { + "value": { + "sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "a2p_profile_bundle_sid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "customer_profile_bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "APPROVED", + "identity_status": "VERIFIED", + "brand_type": "SOLE_PROPRIETOR", + "mock": false, + "tcr_id": null, + "brand_score": null, + "russell_3000": null, + "brand_feedback": null, + "failure_reason": null, + "government_entity": null, + "tax_exempt_status": null, + "skip_automatic_sec_vet": false, + "date_updated": "2023-03-15T14:21:42Z", + "date_created": "2023-03-15T14:21:42Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp" + } + } + } } } }, @@ -1474,10 +1725,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBrandRegistrations" }, "post": { "description": "", @@ -1501,6 +1749,65 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations" + }, + "examples": { + "update": { + "value": { + "sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "brand_type": "STANDARD", + "status": "PENDING", + "tcr_id": "BXXXXXX", + "failure_reason": "Registration error", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_score": 42, + "brand_feedback": [ + "TAX_ID", + "NONPROFIT" + ], + "identity_status": "VERIFIED", + "russell_3000": false, + "government_entity": false, + "tax_exempt_status": "501c3", + "skip_automatic_sec_vet": false, + "mock": false, + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp" + } + } + }, + "updateSoleProprietorBrand": { + "value": { + "sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "brand_type": "SOLE_PROPRIETOR", + "status": "PENDING", + "tcr_id": "BXXXXXX", + "failure_reason": null, + "brand_score": null, + "brand_feedback": null, + "identity_status": "UNVERIFIED", + "russell_3000": false, + "government_entity": false, + "tax_exempt_status": null, + "skip_automatic_sec_vet": false, + "mock": false, + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp" + } + } + } } } }, @@ -1512,10 +1819,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "UpdateBrandRegistrations" } }, "/v1/a2p/BrandRegistrations": { @@ -1530,11 +1834,11 @@ "sid", "date_created" ], - "pathType": "list", "dependentProperties": { "brand_vetting": "{brand_sid: sid}", "brand_registration_otp": "{brand_registration_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "", @@ -1582,16 +1886,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1600,18 +1906,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "data", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0" + }, + "data": [ + { + "sid": "BN0044409f7e067e279523808d267e2d85", + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "customer_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "a2p_profile_bundle_sid": "BU3344409f7e067e279523808d267e2d85", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "brand_type": "STANDARD", + "status": "APPROVED", + "tcr_id": "BXXXXXX", + "failure_reason": "Registration error", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85", + "brand_score": 42, + "brand_feedback": [ + "TAX_ID", + "NONPROFIT" + ], + "identity_status": "VERIFIED", + "russell_3000": true, + "tax_exempt_status": "501c3", + "government_entity": false, + "skip_automatic_sec_vet": false, + "mock": false, + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp" + } + } + ] } } } @@ -1625,10 +1974,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBrandRegistrations" }, "post": { "description": "", @@ -1638,6 +1984,65 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations" + }, + "examples": { + "create": { + "value": { + "sid": "BN0044409f7e067e279523808d267e2d85", + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "customer_profile_bundle_sid": "BU0000009f7e067e279523808d267e2d90", + "a2p_profile_bundle_sid": "BU1111109f7e067e279523808d267e2d85", + "date_created": "2021-01-28T10:45:51Z", + "date_updated": "2021-01-28T10:45:51Z", + "brand_type": "STANDARD", + "status": "PENDING", + "tcr_id": "BXXXXXX", + "failure_reason": "Registration error", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85", + "brand_score": 42, + "brand_feedback": [ + "TAX_ID", + "NONPROFIT" + ], + "identity_status": "VERIFIED", + "russell_3000": true, + "government_entity": false, + "tax_exempt_status": "501c3", + "skip_automatic_sec_vet": false, + "mock": false, + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp" + } + } + }, + "createSoleProprietorBrand": { + "value": { + "sid": "BN0044409f7e067e279523808d267e2d85", + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "customer_profile_bundle_sid": "BU0000009f7e067e279523808d267e2d90", + "a2p_profile_bundle_sid": "BU1111109f7e067e279523808d267e2d85", + "date_created": "2021-01-28T10:45:51Z", + "date_updated": "2021-01-28T10:45:51Z", + "brand_type": "SOLE_PROPRIETOR", + "status": "PENDING", + "tcr_id": "BXXXXXX", + "failure_reason": null, + "brand_score": null, + "brand_feedback": null, + "identity_status": "UNVERIFIED", + "russell_3000": false, + "government_entity": false, + "tax_exempt_status": null, + "skip_automatic_sec_vet": false, + "mock": false, + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85", + "links": { + "brand_vettings": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings", + "brand_registration_otps": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp" + } + } + } } } }, @@ -1650,9 +2055,6 @@ } ], "operationId": "CreateBrandRegistrations", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1691,6 +2093,26 @@ "CustomerProfileBundleSid", "A2PProfileBundleSid" ] + }, + "examples": { + "create": { + "value": { + "CustomerProfileBundleSid": "BU0000009f7e067e279523808d267e2d90", + "A2PProfileBundleSid": "BU1111109f7e067e279523808d267e2d85", + "BrandType": "STANDARD", + "SkipAutomaticSecVet": false, + "Mock": false + } + }, + "createSoleProprietorBrand": { + "value": { + "CustomerProfileBundleSid": "BU0000009f7e067e279523808d267e2d90", + "A2PProfileBundleSid": "BU1111109f7e067e279523808d267e2d85", + "BrandType": "STANDARD", + "SkipAutomaticSecVet": false, + "Mock": false + } + } } } } @@ -1714,9 +2136,9 @@ "vetting_status", "vetting_class" ], - "pathType": "list", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_vettings" + "mountName": "brand_vettings", + "pathType": "list" }, "post": { "description": "", @@ -1740,6 +2162,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_vetting" + }, + "examples": { + "create": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_sid": "BN0044409f7e067e279523808d267e2d85", + "brand_vetting_sid": "VT12445353", + "vetting_provider": "campaign-verify", + "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", + "vetting_class": "POLITICAL", + "vetting_status": "IN_PROGRESS", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:35Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353" + } + } } } }, @@ -1752,9 +2190,6 @@ } ], "operationId": "CreateBrandVetting", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1775,6 +2210,14 @@ "required": [ "VettingProvider" ] + }, + "examples": { + "create": { + "value": { + "VettingProvider": "campaign-verify", + "VettingId": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY" + } + } } } } @@ -1847,16 +2290,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1865,18 +2310,45 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "data", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0" + }, + "data": [ + { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_sid": "BN0044409f7e067e279523808d267e2d85", + "brand_vetting_sid": "VT12445353", + "vetting_provider": "campaign-verify", + "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", + "vetting_class": "POLITICAL", + "vetting_status": "IN_PROGRESS", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:35Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353" + } + ] } } } @@ -1890,10 +2362,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBrandVetting", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBrandVetting" } }, "/v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}": { @@ -1913,9 +2382,9 @@ "vetting_status", "vetting_class" ], - "pathType": "instance", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_vettings" + "mountName": "brand_vettings", + "pathType": "instance" }, "get": { "description": "", @@ -1951,6 +2420,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_vetting" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_sid": "BN0044409f7e067e279523808d267e2d85", + "brand_vetting_sid": "VT12445353", + "vetting_provider": "campaign-verify", + "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY", + "vetting_class": "POLITICAL", + "vetting_status": "IN_PROGRESS", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:35Z", + "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353" + } + } } } }, @@ -1962,10 +2447,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBrandVetting", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBrandVetting" } }, "/v1/Deactivations": { @@ -1979,8 +2461,8 @@ "defaultOutputProperties": [ "redirect_to" ], - "pathType": "instance", - "className": "deactivations" + "className": "deactivations", + "pathType": "instance" }, "get": { "description": "Fetch a list of all United States numbers that have been deactivated on a specific date.", @@ -2001,6 +2483,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.deactivation" + }, + "examples": { + "fetch": { + "value": { + "redirect_to": "https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com" + } + } } } }, @@ -2012,10 +2501,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeactivation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDeactivation" } }, "/v1/LinkShortening/Domains/{DomainSid}/Certificate": { @@ -2024,7 +2510,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "certificate_sid", @@ -2035,9 +2521,9 @@ "date_updated", "url" ], - "pathType": "instance", "mountName": "domain_certs", - "className": "domain_certs" + "className": "domain_certs", + "pathType": "instance" }, "post": { "description": "", @@ -2061,6 +2547,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + }, + "examples": { + "update": { + "value": { + "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "https://api.example.com", + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_expires": "2021-02-06T18:02:04Z", + "date_created": "2021-02-06T18:02:04Z", + "date_updated": "2021-02-06T18:02:04Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", + "cert_in_validation": { + "date_expires": "2021-02-06T18:02:04Z", + "status": "pending" + } + } + } } } }, @@ -2071,6 +2574,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + }, + "examples": { + "create": { + "value": { + "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "https://api.example.com", + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_expires": null, + "date_created": "2021-02-06T18:02:04Z", + "date_updated": "2021-02-06T18:02:04Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", + "cert_in_validation": { + "date_expires": "2021-02-06T18:02:04Z", + "status": "pending" + } + } + } } } }, @@ -2083,9 +2603,6 @@ } ], "operationId": "UpdateDomainCertV4", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2101,6 +2618,18 @@ "required": [ "TlsCert" ] + }, + "examples": { + "update": { + "value": { + "TlsCert": "-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END CERTIFICATE----------BEGIN PRIVATE KEY-----\nMIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV\n80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A\np1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP\nk0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R\nZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX\nG2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h\nKSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6\nn6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU\n9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq\n3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh\nTOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft\nBtm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR\n/B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY\n/77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig\nSIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx\n4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG\nSLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4\nFBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8\nShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg\nNsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx\n9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz\nFlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM\n7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv\nsyI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ\n9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q==\n-----END PRIVATE KEY-----" + } + }, + "create": { + "value": { + "TlsCert": "-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END CERTIFICATE----------BEGIN PRIVATE KEY-----\nMIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV\n80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A\np1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP\nk0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R\nZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX\nG2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h\nKSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6\nn6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU\n9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq\n3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh\nTOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft\nBtm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR\n/B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY\n/77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig\nSIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx\n4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG\nSLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4\nFBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8\nShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg\nNsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx\n9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz\nFlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM\n7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv\nsyI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ\n9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q==\n-----END PRIVATE KEY-----" + } + } } } } @@ -2128,6 +2657,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_cert_v4" + }, + "examples": { + "fetch": { + "value": { + "certificate_sid": "CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "https://api.example.com", + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_expires": "2021-02-06T18:02:04Z", + "date_created": "2021-02-06T18:02:04Z", + "date_updated": "2021-02-06T18:02:04Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate", + "cert_in_validation": { + "date_expires": "2021-02-06T18:02:04Z", + "status": "pending" + } + } + } } } }, @@ -2139,10 +2685,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainCertV4", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainCertV4" }, "delete": { "description": "", @@ -2170,10 +2713,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDomainCertV4", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteDomainCertV4" } }, "/v1/LinkShortening/Domains/{DomainSid}/Config": { @@ -2182,7 +2722,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "config_sid", @@ -2194,8 +2734,8 @@ "url", "disable_https" ], - "pathType": "instance", - "mountName": "domain_config" + "mountName": "domain_config", + "pathType": "instance" }, "post": { "description": "", @@ -2219,6 +2759,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config" + }, + "examples": { + "update": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config", + "disable_https": false + } + } } } }, @@ -2229,6 +2784,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config" + }, + "examples": { + "create": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config", + "disable_https": false + } + } } } }, @@ -2241,9 +2811,6 @@ } ], "operationId": "UpdateDomainConfig", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2270,6 +2837,24 @@ "description": "Customer's choice to send links with/without \"https://\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified." } } + }, + "examples": { + "update": { + "value": { + "FallbackUrl": "https://www.example.com", + "CallbackUrl": "https://www.example.com", + "ContinueOnFailure": true, + "DisableHttps": false + } + }, + "create": { + "value": { + "FallbackUrl": "https://www.example.com", + "CallbackUrl": "https://www.example.com", + "DisableHttps": false, + "ContinueOnFailure": true + } + } } } } @@ -2297,6 +2882,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config" + }, + "examples": { + "fetch": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config", + "disable_https": false + } + } } } }, @@ -2308,10 +2908,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainConfig", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainConfig" } }, "/v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig": { @@ -2320,7 +2917,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "domain_sid", @@ -2333,8 +2930,8 @@ "url", "messaging_service_sid" ], - "pathType": "instance", - "mountName": "domain_config_messaging_service" + "mountName": "domain_config_messaging_service", + "pathType": "instance" }, "get": { "description": "", @@ -2358,6 +2955,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.domain_config_messaging_service" + }, + "examples": { + "fetch": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "config_sid": "ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fallback_url": "https://www.example.com", + "callback_url": "https://www.example.com", + "continue_on_failure": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://messaging.twilio.com/v1/LinkShortening/MessagingService/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DomainConfig", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2369,10 +2981,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainConfigMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainConfigMessagingService" } }, "/v1/Services/PreregisteredUsa2p": { @@ -2387,8 +2996,8 @@ "campaign_id", "messaging_service_sid" ], - "pathType": "list", - "mountName": "external_campaign" + "mountName": "external_campaign", + "pathType": "list" }, "post": { "description": "", @@ -2398,6 +3007,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.external_campaign" + }, + "examples": { + "create": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "campaign_id": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-03-21T21:31:00Z" + } + } } } }, @@ -2410,9 +3030,6 @@ } ], "operationId": "CreateExternalCampaign", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2436,6 +3053,14 @@ "CampaignId", "MessagingServiceSid" ] + }, + "examples": { + "create": { + "value": { + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CampaignId": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2448,15 +3073,15 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "messaging_service_sid", "domain_sid", "url" ], - "pathType": "instance", - "mountName": "linkshortening_messaging_service" + "mountName": "linkshortening_messaging_service", + "pathType": "instance" }, "post": { "description": "", @@ -2492,6 +3117,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.linkshortening_messaging_service" + }, + "examples": { + "create": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2503,10 +3137,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateLinkshorteningMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateLinkshorteningMessagingService" }, "delete": { "description": "", @@ -2546,10 +3177,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteLinkshorteningMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteLinkshorteningMessagingService" } }, "/v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain": { @@ -2558,15 +3186,15 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "domain_sid", "messaging_service_sid", "url" ], - "pathType": "instance", - "mountName": "linkshortening_messaging_service_domain_association" + "mountName": "linkshortening_messaging_service_domain_association", + "pathType": "instance" }, "get": { "description": "", @@ -2590,6 +3218,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.linkshortening_messaging_service_domain_association" + }, + "examples": { + "fetch": { + "value": { + "domain_sid": "DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://messaging.twilio.com/v1/LinkShortening/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Domain" + } + } } } }, @@ -2601,10 +3238,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchLinkshorteningMessagingServiceDomainAssociation", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchLinkshorteningMessagingServiceDomainAssociation" } }, "/v1/Services/{ServiceSid}/PhoneNumbers": { @@ -2620,8 +3254,8 @@ "phone_number", "country_code" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2645,6 +3279,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.phone_number" + }, + "examples": { + "create": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "+987654321", + "country_code": "US", + "capabilities": [], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCapabilities": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "+987654321", + "country_code": "US", + "capabilities": [ + "MMS", + "SMS", + "Voice" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2657,9 +3323,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2678,6 +3341,18 @@ "required": [ "PhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCapabilities": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2741,16 +3416,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2759,18 +3436,44 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "phone_numbers", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0" + }, + "phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "+987654321", + "country_code": "US", + "capabilities": [], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2784,10 +3487,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}": { @@ -2803,8 +3503,8 @@ "phone_number", "country_code" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "", @@ -2841,10 +3541,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePhoneNumber" }, "get": { "description": "", @@ -2877,6 +3574,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.phone_number" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "phone_number": "12345", + "country_code": "US", + "capabilities": [], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2888,10 +3600,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" } }, "/v1/Services": { @@ -2907,15 +3616,15 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "phone_number": "{service_sid: sid}", "short_code": "{service_sid: sid}", "alpha_sender": "{service_sid: sid}", - "messaging/v1/message": "{messaging_service_sid: sid}", + "message": "{messaging_service_sid: sid}", "us_app_to_person": "{messaging_service_sid: sid}", "us_app_to_person_usecase": "{messaging_service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -2925,6 +3634,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "friendly_name": "My Service!", + "inbound_request_url": "https://www.example.com/", + "inbound_method": "POST", + "fallback_url": "https://www.example.com", + "fallback_method": "GET", + "status_callback": "https://www.example.com", + "sticky_sender": true, + "smart_encoding": false, + "mms_converter": true, + "fallback_to_long_code": true, + "scan_message_content": "inherit", + "area_code_geomatch": true, + "validity_period": 600, + "synchronous_validation": true, + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": true, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2937,9 +3682,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3037,6 +3779,28 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "My Service!", + "StickySender": true, + "MmsConverter": true, + "SmartEncoding": false, + "FallbackToLongCode": true, + "InboundRequestUrl": "https://www.example.com", + "InboundMethod": "POST", + "FallbackMethod": "GET", + "FallbackUrl": "https://www.example.com", + "StatusCallback": "https://www.example.com", + "ScanMessageContent": "inherit", + "AreaCodeGeomatch": true, + "ValidityPeriod": 600, + "SynchronousValidation": true, + "Usecase": "marketing", + "UseInboundWebhookOnNumber": true + } + } } } } @@ -3088,16 +3852,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3106,18 +3872,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "services", + "url": "https://messaging.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My Service!", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "sticky_sender": true, + "mms_converter": true, + "smart_encoding": false, + "fallback_to_long_code": true, + "area_code_geomatch": true, + "validity_period": 600, + "scan_message_content": "inherit", + "synchronous_validation": true, + "inbound_request_url": "https://www.example.com/", + "inbound_method": "POST", + "fallback_url": null, + "fallback_method": "POST", + "status_callback": "https://www.example.com", + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": false, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -3131,10 +3944,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -3150,15 +3960,15 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "phone_number": "{service_sid: sid}", "short_code": "{service_sid: sid}", "alpha_sender": "{service_sid: sid}", - "messaging/v1/message": "{messaging_service_sid: sid}", + "message": "{messaging_service_sid: sid}", "us_app_to_person": "{messaging_service_sid: sid}", "us_app_to_person_usecase": "{messaging_service_sid: sid}" - } + }, + "pathType": "instance" }, "post": { "description": "", @@ -3182,6 +3992,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My Service!", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "sticky_sender": false, + "mms_converter": true, + "smart_encoding": false, + "fallback_to_long_code": true, + "scan_message_content": "inherit", + "synchronous_validation": true, + "area_code_geomatch": true, + "validity_period": 600, + "inbound_request_url": "https://www.example.com", + "inbound_method": "POST", + "fallback_url": null, + "fallback_method": "POST", + "status_callback": "https://www.example.com", + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": true, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3194,9 +4040,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3291,6 +4134,13 @@ "description": "A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service." } } + }, + "examples": { + "update": { + "value": { + "StickySender": false + } + } } } } @@ -3318,6 +4168,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "friendly_name": "My Service!", + "inbound_request_url": "https://www.example.com/", + "inbound_method": "POST", + "fallback_url": null, + "fallback_method": "POST", + "status_callback": "https://www.example.com", + "sticky_sender": true, + "mms_converter": true, + "smart_encoding": false, + "fallback_to_long_code": true, + "area_code_geomatch": true, + "validity_period": 600, + "scan_message_content": "inherit", + "synchronous_validation": true, + "usecase": "marketing", + "us_app_to_person_registered": false, + "use_inbound_webhook_on_number": true, + "links": { + "phone_numbers": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes", + "alpha_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders", + "messages": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", + "us_app_to_person": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p", + "us_app_to_person_usecases": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3329,10 +4215,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -3360,10 +4243,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" } }, "/v1/Services/{ServiceSid}/ShortCodes": { @@ -3379,8 +4259,8 @@ "short_code", "country_code" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3404,6 +4284,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.short_code" + }, + "examples": { + "create": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "short_code": "12345", + "country_code": "US", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3416,9 +4313,6 @@ } ], "operationId": "CreateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3437,6 +4331,13 @@ "required": [ "ShortCodeSid" ] + }, + "examples": { + "create": { + "value": { + "ShortCodeSid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3500,16 +4401,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3518,18 +4421,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "short_codes", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0" + }, + "short_codes": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "short_code": "12345", + "country_code": "US", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -3543,10 +4474,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "ListShortCode" } }, "/v1/Services/{ServiceSid}/ShortCodes/{Sid}": { @@ -3562,8 +4490,8 @@ "short_code", "country_code" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "", @@ -3600,10 +4528,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteShortCode" }, "get": { "description": "", @@ -3636,6 +4561,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.short_code" + }, + "examples": { + "fetch": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:12:31Z", + "date_updated": "2015-07-30T20:12:33Z", + "short_code": "12345", + "country_code": "US", + "capabilities": [ + "SMS" + ], + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3647,10 +4589,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchShortCode" } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p": { @@ -3666,9 +4605,9 @@ "campaign_status", "date_created" ], - "pathType": "list", "parent": "/Services/{Sid}", - "mountName": "us_app_to_person" + "mountName": "us_app_to_person", + "pathType": "list" }, "post": { "description": "", @@ -3692,6 +4631,158 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person" + }, + "examples": { + "create": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [] + } + }, + "createWithDefaults": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed. You will not receive any more messages from this number. Reply START to resubscribe.", + "help_message": "Reply STOP to unsubscribe. Msg&Data Rates May Apply.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP", + "STOPALL", + "UNSUBSCRIBE", + "CANCEL", + "END", + "QUIT" + ], + "help_keywords": [ + "HELP", + "INFO" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [] + } + }, + "createWithDefaultsSoleProprietor": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "SOLE_PROPRIETOR", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 0.25, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "LOW" + } + }, + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed. You will not receive any more messages from this number. Reply START to resubscribe.", + "help_message": "Reply STOP to unsubscribe. Msg&Data Rates May Apply.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP", + "STOPALL", + "UNSUBSCRIBE", + "CANCEL", + "END", + "QUIT" + ], + "help_keywords": [ + "HELP", + "INFO" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [] + } + } } } }, @@ -3704,9 +4795,6 @@ } ], "operationId": "CreateUsAppToPerson", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3791,6 +4879,70 @@ "HasEmbeddedLinks", "HasEmbeddedPhone" ] + }, + "examples": { + "create": { + "value": { + "BrandRegistrationSid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Description": "Send marketing messages about sales to opted in customers.", + "MessageSamples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "UsAppToPersonUsecase": "MARKETING", + "MessageFlow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "OptInMessage": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "OptOutMessage": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "HelpMessage": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "OptInKeywords": [ + "START" + ], + "OptOutKeywords": [ + "STOP" + ], + "HelpKeywords": [ + "HELP" + ], + "HasEmbeddedLinks": true, + "HasEmbeddedPhone": false + } + }, + "createWithDefaults": { + "value": { + "BrandRegistrationSid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Description": "Send marketing messages about sales to opted in customers.", + "MessageSamples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "UsAppToPersonUsecase": "MARKETING", + "MessageFlow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "OptInMessage": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "OptInKeywords": [ + "START" + ], + "HasEmbeddedLinks": true, + "HasEmbeddedPhone": false + } + }, + "createWithDefaultsSoleProprietor": { + "value": { + "BrandRegistrationSid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Description": "Send marketing messages about sales to opted in customers.", + "MessageSamples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "UsAppToPersonUsecase": "SOLE_PROPRIETOR", + "MessageFlow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "OptInMessage": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "OptInKeywords": [ + "START" + ], + "HasEmbeddedLinks": true, + "HasEmbeddedPhone": false + } + } } } } @@ -3854,16 +5006,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3872,17 +5026,144 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "compliance": [ + { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "key": "compliance" + } + } + }, + "readFailed": { + "value": { + "compliance": [ + { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [ + { + "error_code": 30897, + "fields": [ + "MESSAGE_FLOW" + ], + "url": "https://www.twilio.com/docs/api/errors/30897", + "description": "The campaign submission has been reviewed and it was rejected due to Disallowed Content." + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "key": "compliance" } } } @@ -3897,10 +5178,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "ListUsAppToPerson" } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}": { @@ -3916,9 +5194,9 @@ "campaign_status", "date_created" ], - "pathType": "instance", "parent": "/Services/{Sid}", - "mountName": "us_app_to_person" + "mountName": "us_app_to_person", + "pathType": "instance" }, "delete": { "description": "", @@ -3958,10 +5236,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteUsAppToPerson" }, "get": { "description": "", @@ -3997,6 +5272,153 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person" + }, + "examples": { + "fetch": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [] + } + }, + "fetchSoleProprietorCampaign": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send confirmation messages about scheduled home repair services", + "message_samples": [ + "Hi! This is John Doe. I'm scheduled to come to your home at 123 Example Street to repair your roof at 4pm tomorrow. Please let me know if this time does not work for you anymore" + ], + "us_app_to_person_usecase": "SOLE_PROPRIETOR", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users call (111)-222-3333 to schedule appointments, where they're also asked whether they would like to provide their phone numbers to receive appointment reminders ", + "opt_in_message": "John Doe's Home Repair: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from John Doe's Home Repair. You will not receive any more messages from this number.", + "help_message": "John Doe's Home Repair: Please call (111)-222-3333 to get help. To opt-out, please reply STOP", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [] + } + }, + "fetchFailedWithErrors": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send confirmation messages about scheduled home repair services", + "message_samples": [ + "Hi! This is John Doe. I'm scheduled to come to your home at 123 Example Street to repair your roof at 4pm tomorrow. Please let me know if this time does not work for you anymore" + ], + "us_app_to_person_usecase": "SOLE_PROPRIETOR", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "message_flow": "End users call (111)-222-3333 to schedule appointments, where they're also asked whether they would like to provide their phone numbers to receive appointment reminders ", + "opt_in_message": "John Doe's Home Repair: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from John Doe's Home Repair. You will not receive any more messages from this number.", + "help_message": "John Doe's Home Repair: Please call (111)-222-3333 to get help. To opt-out, please reply STOP", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "mock": false, + "errors": [ + { + "error_code": 30897, + "fields": [ + "MESSAGE_FLOW" + ], + "url": "https://www.twilio.com/docs/api/errors/30897", + "description": "The campaign submission has been reviewed and it was rejected due to Disallowed Content." + } + ] + } + } } } }, @@ -4008,10 +5430,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsAppToPerson" } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases": { @@ -4025,9 +5444,9 @@ "defaultOutputProperties": [ "us_app_to_person_usecases" ], - "pathType": "list", "parent": "/Services/{Sid}", - "mountName": "us_app_to_person_usecases" + "mountName": "us_app_to_person_usecases", + "pathType": "list" }, "get": { "description": "", @@ -4053,6 +5472,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^BN[0-9a-fA-F]{32}$" + }, + "examples": { + "fetchWithBrandRegistrationSid": { + "value": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } } ], @@ -4062,6 +5486,260 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person_usecase" + }, + "examples": { + "fetchWithBrandRegistrationSid": { + "value": { + "us_app_to_person_usecases": [ + { + "code": "2FA", + "name": "Two-Factor authentication (2FA)", + "description": "Two-Factor authentication, one-time use password, password reset", + "post_approval_required": false + }, + { + "code": "ACCOUNT_NOTIFICATION", + "name": "Account Notification", + "description": "All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)", + "post_approval_required": false + }, + { + "code": "AGENTS_FRANCHISES", + "name": "Agents and Franchises", + "description": "For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office.", + "post_approval_required": true + }, + { + "code": "CHARITY", + "name": "Charity", + "description": "Includes: 5013C Charity\nDoes not include: Religious organizations", + "post_approval_required": false + }, + { + "code": "PROXY", + "name": "Proxy", + "description": "Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe)\nSupporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)", + "post_approval_required": true + }, + { + "code": "CUSTOMER_CARE", + "name": "Customer Care", + "description": "All customer care messaging, including account management and support", + "post_approval_required": false + }, + { + "code": "DELIVERY_NOTIFICATION", + "name": "Delivery Notification", + "description": "Information about the status of the delivery of a product or service", + "post_approval_required": false + }, + { + "code": "EMERGENCY", + "name": "Emergency", + "description": "Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies", + "post_approval_required": true + }, + { + "code": "FRAUD_ALERT", + "name": "Fraud Alert Messaging", + "description": "Fraud alert notification", + "post_approval_required": false + }, + { + "code": "HIGHER_EDUCATION", + "name": "Higher Education", + "description": "For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any \"free to the consumer\" messaging model", + "post_approval_required": false + }, + { + "code": "K12_EDUCATION", + "name": "K-12 Education", + "description": "Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools.", + "post_approval_required": true + }, + { + "code": "LOW_VOLUME", + "name": "Low Volume Mixed", + "description": "Low throughput, any combination of use-cases. Examples include: test, demo accounts", + "post_approval_required": false + }, + { + "code": "MARKETING", + "name": "Marketing", + "description": "Any communication with marketing and/or promotional content", + "post_approval_required": false + }, + { + "code": "MIXED", + "name": "Mixed", + "description": "Mixed messaging reserved for specific consumer service industry", + "post_approval_required": false + }, + { + "code": "POLITICAL", + "name": "Political", + "description": "Part of organized effort to influence decision making of specific group. All campaigns to be verified", + "post_approval_required": false + }, + { + "code": "POLLING_VOTING", + "name": "Polling and voting", + "description": "Polling and voting", + "post_approval_required": false + }, + { + "code": "PUBLIC_SERVICE_ANNOUNCEMENT", + "name": "Public Service Announcement", + "description": "An informational message that is meant to raise the audience awareness about an important issue", + "post_approval_required": false + }, + { + "code": "SECURITY_ALERT", + "name": "Security Alert", + "description": "A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take", + "post_approval_required": false + }, + { + "code": "SOCIAL", + "name": "Social", + "description": "Communication within or between closed communities (For example: influencers alerts)", + "post_approval_required": true + }, + { + "code": "SWEEPSTAKE", + "name": "Sweepstake", + "description": "Sweepstake", + "post_approval_required": true + } + ] + } + }, + "fetchWithoutBrandRegistrationSid": { + "value": { + "us_app_to_person_usecases": [ + { + "code": "2FA", + "name": "Two-Factor authentication (2FA)", + "description": "Two-Factor authentication, one-time use password, password reset", + "post_approval_required": false + }, + { + "code": "ACCOUNT_NOTIFICATION", + "name": "Account Notification", + "description": "All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)", + "post_approval_required": false + }, + { + "code": "AGENTS_FRANCHISES", + "name": "Agents and Franchises", + "description": "For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office.", + "post_approval_required": true + }, + { + "code": "CHARITY", + "name": "Charity", + "description": "Includes: 5013C Charity\nDoes not include: Religious organizations", + "post_approval_required": false + }, + { + "code": "PROXY", + "name": "Proxy", + "description": "Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe)\nSupporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)", + "post_approval_required": true + }, + { + "code": "CUSTOMER_CARE", + "name": "Customer Care", + "description": "All customer care messaging, including account management and support", + "post_approval_required": false + }, + { + "code": "DELIVERY_NOTIFICATION", + "name": "Delivery Notification", + "description": "Information about the status of the delivery of a product or service", + "post_approval_required": false + }, + { + "code": "EMERGENCY", + "name": "Emergency", + "description": "Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies", + "post_approval_required": true + }, + { + "code": "FRAUD_ALERT", + "name": "Fraud Alert Messaging", + "description": "Fraud alert notification", + "post_approval_required": false + }, + { + "code": "HIGHER_EDUCATION", + "name": "Higher Education", + "description": "For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any \"free to the consumer\" messaging model", + "post_approval_required": false + }, + { + "code": "K12_EDUCATION", + "name": "K-12 Education", + "description": "Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools.", + "post_approval_required": true + }, + { + "code": "LOW_VOLUME", + "name": "Low Volume Mixed", + "description": "Low throughput, any combination of use-cases. Examples include: test, demo accounts", + "post_approval_required": false + }, + { + "code": "MARKETING", + "name": "Marketing", + "description": "Any communication with marketing and/or promotional content", + "post_approval_required": false + }, + { + "code": "MIXED", + "name": "Mixed", + "description": "Mixed messaging reserved for specific consumer service industry", + "post_approval_required": false + }, + { + "code": "POLITICAL", + "name": "Political", + "description": "Part of organized effort to influence decision making of specific group. All campaigns to be verified", + "post_approval_required": false + }, + { + "code": "POLLING_VOTING", + "name": "Polling and voting", + "description": "Polling and voting", + "post_approval_required": false + }, + { + "code": "PUBLIC_SERVICE_ANNOUNCEMENT", + "name": "Public Service Announcement", + "description": "An informational message that is meant to raise the audience awareness about an important issue", + "post_approval_required": false + }, + { + "code": "SECURITY_ALERT", + "name": "Security Alert", + "description": "A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take", + "post_approval_required": false + }, + { + "code": "SOCIAL", + "name": "Social", + "description": "Communication within or between closed communities (For example: influencers alerts)", + "post_approval_required": true + }, + { + "code": "SWEEPSTAKE", + "name": "Sweepstake", + "description": "Sweepstake", + "post_approval_required": true + } + ] + } + } } } }, @@ -4073,10 +5751,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsAppToPersonUsecase", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsAppToPersonUsecase" } }, "/v1/Services/Usecases": { @@ -4100,6 +5775,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.usecase" + }, + "examples": { + "fetch": { + "value": { + "usecases": [ + { + "usecase": "notifications", + "description": "Transactional notifications and Alerts for any Delivery, Account, Reminder, Order, Fraud, Security, Public Service, or Emergency announcements.", + "purpose": "Notify my users." + }, + { + "usecase": "marketing", + "description": "Marketing messages may contain product information, offers, and calls to action to engage with your organization.", + "purpose": "Market my services." + } + ] + } + } } } }, @@ -4111,10 +5804,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsecase", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsecase" } } }, @@ -4122,15 +5812,5 @@ { "url": "https://messaging.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_microvisor_v1.json b/spec/json/twilio_microvisor_v1.json index 6794a24a..3ac5bc6d 100644 --- a/spec/json/twilio_microvisor_v1.json +++ b/spec/json/twilio_microvisor_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "microvisor.v1.account_config": { "type": "object", @@ -252,12 +258,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -273,7 +273,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -283,11 +283,11 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "account_configs" + "mountName": "account_configs", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Configs for an Account.", @@ -335,16 +335,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -353,17 +355,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "configs": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" + } + } + }, + "readFull": { + "value": { + "configs": [ + { + "key": "first", + "value": "something", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + }, + { + "key": "second", + "value": "or other", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Configs/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" } } } @@ -378,10 +421,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAccountConfig" }, "post": { "description": "Create a config for an Account.", @@ -391,6 +431,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" + }, + "examples": { + "createAccountConfig": { + "value": { + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + } + } } } }, @@ -403,9 +453,6 @@ } ], "operationId": "CreateAccountConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -426,6 +473,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountConfig": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -438,11 +493,11 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "account_configs" + "mountName": "account_configs", + "pathType": "instance" }, "get": { "description": "Retrieve a Config for an Account.", @@ -463,6 +518,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" + }, + "examples": { + "fetch": { + "value": { + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + } + } } } }, @@ -474,10 +539,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAccountConfig" }, "post": { "description": "Update a config for an Account.", @@ -498,6 +560,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" + }, + "examples": { + "update": { + "value": { + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Configs/first" + } + } } } }, @@ -510,9 +582,6 @@ } ], "operationId": "UpdateAccountConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -528,6 +597,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -556,10 +632,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAccountConfig" } }, "/v1/Secrets": { @@ -568,11 +641,11 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "account_secrets" + "mountName": "account_secrets", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Secrets for an Account.", @@ -620,16 +693,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -638,17 +713,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "secrets": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" + } + } + }, + "readFull": { + "value": { + "secrets": [ + { + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + }, + { + "key": "second", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Secrets/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" } } } @@ -663,10 +777,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAccountSecret" }, "post": { "description": "Create a secret for an Account.", @@ -676,6 +787,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" + }, + "examples": { + "createAccountSecret": { + "value": { + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + } + } } } }, @@ -688,9 +808,6 @@ } ], "operationId": "CreateAccountSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -711,6 +828,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountSecret": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -723,11 +848,11 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "account_secrets" + "mountName": "account_secrets", + "pathType": "instance" }, "get": { "description": "Retrieve a Secret for an Account.", @@ -748,6 +873,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" + }, + "examples": { + "fetch": { + "value": { + "key": "first", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + } + } } } }, @@ -759,10 +893,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAccountSecret" }, "post": { "description": "Update a secret for an Account.", @@ -783,6 +914,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" + }, + "examples": { + "update": { + "value": { + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Secrets/first" + } + } } } }, @@ -795,9 +935,6 @@ } ], "operationId": "UpdateAccountSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -813,6 +950,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -841,10 +985,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAccountSecret" } }, "/v1/Apps": { @@ -853,16 +994,16 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "list", "dependentProperties": { "app_manifest": "{app_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Apps for an Account.", @@ -910,16 +1051,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -928,17 +1071,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "apps": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "next_page_url": null, + "key": "apps" + } + } + }, + "readFull": { + "value": { + "apps": [ + { + "sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "hash": "hash", + "unique_name": "unique name", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", + "next_page_url": null, + "key": "apps" } } } @@ -953,10 +1137,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListApp", - "x-maturity": [ - "Preview" - ] + "operationId": "ListApp" } }, "/v1/Apps/{Sid}": { @@ -965,16 +1146,16 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "instance", "dependentProperties": { "app_manifest": "{app_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific App.", @@ -995,6 +1176,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.app" + }, + "examples": { + "fetch": { + "value": { + "sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "hash": "hash", + "unique_name": "look at this crazy app", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" + } + } + } } } }, @@ -1006,10 +1203,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApp", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchApp" }, "delete": { "description": "Delete a specific App.", @@ -1034,10 +1228,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteApp", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteApp" } }, "/v1/Apps/{AppSid}/Manifest": { @@ -1046,12 +1237,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Apps/{Sid}", - "mountName": "app_manifests" + "mountName": "app_manifests", + "pathType": "instance" }, "get": { "description": "Retrieve the Manifest for an App.", @@ -1072,6 +1263,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.app.app_manifest" + }, + "examples": { + "fetch": { + "value": { + "app_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "hash": "some hash", + "encoded_bytes": "some value", + "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" + } + } } } }, @@ -1083,10 +1284,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAppManifest", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAppManifest" } }, "/v1/Devices": { @@ -1095,17 +1293,17 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "list", "dependentProperties": { "device_config": "{device_sid: sid}", "device_secret": "{device_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Devices registered with the Account.", @@ -1153,16 +1351,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1171,17 +1371,71 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "devices": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "next_page_url": null, + "key": "devices" + } + } + }, + "readFull": { + "value": { + "devices": [ + { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "This is my device; there are many like it.", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "up-to-date", + "update_error_code": 0, + "reported_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": true, + "date_expires": "2021-01-01T12:34:56Z" + }, + "date_created": "2021-01-01T12:34:56Z", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", + "next_page_url": null, + "key": "devices" } } } @@ -1196,10 +1450,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDevice" } }, "/v1/Devices/{Sid}": { @@ -1208,17 +1459,17 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "instance", "dependentProperties": { "device_config": "{device_sid: sid}", "device_secret": "{device_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Device.", @@ -1239,6 +1490,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device" + }, + "examples": { + "fetch": { + "value": { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "This is my device; there are many like it.", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "up-to-date", + "update_error_code": 0, + "reported_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": true, + "date_expires": "2021-01-01T12:34:56Z" + }, + "date_created": "2021-01-01T12:34:56Z", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + } } } }, @@ -1250,10 +1530,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDevice" }, "post": { "description": "Update a specific Device.", @@ -1274,6 +1551,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device" + }, + "examples": { + "update": { + "value": { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "UniqueName", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "pending", + "update_error_code": 0, + "reported_sid": null, + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": false, + "date_expires": null + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + }, + "restartApp": { + "value": { + "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "UniqueName", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "app": { + "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_hash": null, + "date_targeted": "2021-01-01T12:34:56Z", + "update_status": "pending", + "update_error_code": 0, + "reported_sid": null, + "date_reported": "2021-01-01T12:34:56Z" + }, + "logging": { + "enabled": false, + "date_expires": null + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", + "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" + } + } + } } } }, @@ -1286,9 +1619,6 @@ } ], "operationId": "UpdateDevice", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1307,6 +1637,24 @@ "LoggingEnabled": { "type": "boolean", "description": "A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours." + }, + "RestartApp": { + "type": "boolean", + "description": "Set to true to restart the App running on the Device." + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "TargetApp": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "LoggingEnabled": false + } + }, + "restartApp": { + "value": { + "RestartApp": true } } } @@ -1321,12 +1669,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Devices/{Sid}", - "mountName": "device_configs" + "mountName": "device_configs", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Configs for a Device.", @@ -1383,16 +1731,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1401,17 +1751,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "configs": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" + } + } + }, + "readFull": { + "value": { + "configs": [ + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "some value", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + }, + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "second", + "value": "some value", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", + "next_page_url": null, + "key": "configs" } } } @@ -1426,10 +1819,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeviceConfig" }, "post": { "description": "Create a config for a Microvisor Device.", @@ -1450,6 +1840,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" + }, + "examples": { + "createAccountConfig": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "some value", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + } + } } } }, @@ -1462,9 +1863,6 @@ } ], "operationId": "CreateDeviceConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1485,6 +1883,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountConfig": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -1497,12 +1903,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Devices/{Sid}", - "mountName": "device_configs" + "mountName": "device_configs", + "pathType": "instance" }, "get": { "description": "Retrieve a Config for a Device.", @@ -1532,6 +1938,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" + }, + "examples": { + "fetch": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "some value", + "date_updated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + } + } } } }, @@ -1543,10 +1960,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeviceConfig" }, "post": { "description": "Update a config for a Microvisor Device.", @@ -1576,6 +1990,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" + }, + "examples": { + "update": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "value": "place", + "date_updated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" + } + } } } }, @@ -1588,9 +2013,6 @@ } ], "operationId": "UpdateDeviceConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1606,6 +2028,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -1643,10 +2072,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeviceConfig" } }, "/v1/Devices/{DeviceSid}/Secrets": { @@ -1655,12 +2081,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Devices/{Sid}", - "mountName": "device_secrets" + "mountName": "device_secrets", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Secrets for a Device.", @@ -1717,16 +2143,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1735,17 +2163,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "secrets": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" + } + } + }, + "readFull": { + "value": { + "secrets": [ + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + }, + { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "second", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/second" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", + "next_page_url": null, + "key": "secrets" } } } @@ -1760,10 +2229,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeviceSecret" }, "post": { "description": "Create a secret for a Microvisor Device.", @@ -1784,6 +2250,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" + }, + "examples": { + "createAccountSecret": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + } + } } } }, @@ -1796,9 +2272,6 @@ } ], "operationId": "CreateDeviceSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1819,6 +2292,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountSecret": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -1831,12 +2312,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Devices/{Sid}", - "mountName": "device_secrets" + "mountName": "device_secrets", + "pathType": "instance" }, "get": { "description": "Retrieve a Secret for a Device.", @@ -1866,6 +2347,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" + }, + "examples": { + "fetch": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:57Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + } + } } } }, @@ -1877,10 +2368,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeviceSecret" }, "post": { "description": "Update a secret for a Microvisor Device.", @@ -1910,6 +2398,16 @@ "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" + }, + "examples": { + "update": { + "value": { + "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "key": "first", + "date_rotated": "2021-01-01T12:34:56Z", + "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" + } + } } } }, @@ -1922,9 +2420,6 @@ } ], "operationId": "UpdateDeviceSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1940,6 +2435,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -1977,10 +2479,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeviceSecret" } } }, @@ -1988,11 +2487,5 @@ { "url": "https://microvisor.twilio.com" } - ], - "x-maturity": [ - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index 328d69f1..966ff419 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "monitor.v1.alert": { "type": "object", @@ -320,12 +326,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -341,7 +341,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -383,6 +383,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/monitor.v1.alert-instance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "alert_text": "alert_text", + "api_version": "2010-04-01", + "date_created": "2015-07-30T20:00:00Z", + "date_generated": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "error_code": "error_code", + "log_level": "log_level", + "more_info": "more_info", + "request_method": "GET", + "request_url": "http://www.example.com", + "request_variables": "request_variables", + "resource_sid": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "response_body": "response_body", + "response_headers": "response_headers", + "request_headers": "request_headers", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "PNe2cd757cd5257b0217a447933a0290d2" + } + } } } }, @@ -394,10 +419,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAlert", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAlert" } }, "/v1/Alerts": { @@ -425,6 +447,14 @@ "description": "Only show alerts for this log-level. Can be: `error`, `warning`, `notice`, or `debug`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "log_level" + }, + "readFull": { + "value": "log_level" + } } }, { @@ -434,6 +464,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2016-01-01" + }, + "readFull": { + "value": "2016-01-01" + } } }, { @@ -443,6 +481,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2016-01-01" + }, + "readFull": { + "value": "2016-01-01" + } } }, { @@ -488,16 +534,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -506,17 +554,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "alerts": [], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0", + "key": "alerts", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "alerts": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "alert_text": "alert_text", + "api_version": "2010-04-01", + "date_created": "2015-07-30T20:00:00Z", + "date_generated": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "error_code": "error_code", + "log_level": "log_level", + "more_info": "more_info", + "request_method": "GET", + "request_url": "http://www.example.com", + "resource_sid": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "PNe2cd757cd5257b0217a447933a0290d2" + } + ], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0", + "key": "alerts", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0" } } } @@ -531,10 +625,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAlert", - "x-maturity": [ - "GA" - ] + "operationId": "ListAlert" } }, "/v1/Events/{Sid}": { @@ -575,6 +666,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/monitor.v1.event" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "account", + "description": null, + "event_data": { + "friendly_name": { + "previous": "SubAccount Created at 2014-10-03 09:48 am", + "updated": "Mr. Friendly" + } + }, + "event_date": "2014-10-03T16:48:25Z", + "event_type": "account.updated", + "links": { + "actor": "https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "resource_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "account", + "sid": "AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "api", + "source_ip_address": "10.86.6.250", + "url": "https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -586,10 +705,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvent" } }, "/v1/Events": { @@ -620,6 +736,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -628,6 +752,14 @@ "description": "Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types).", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "event_type" + }, + "readEmpty": { + "value": "event_type" + } } }, { @@ -639,6 +771,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -647,6 +787,14 @@ "description": "Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "source_ip_address" + }, + "readEmpty": { + "value": "source_ip_address" + } } }, { @@ -656,6 +804,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -665,6 +821,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -710,16 +874,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -728,17 +894,70 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "events": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "account", + "description": null, + "event_data": { + "friendly_name": { + "previous": "SubAccount Created at 2014-10-03 09:48 am", + "updated": "Mr. Friendly" + } + }, + "event_date": "2014-10-03T16:48:25Z", + "event_type": "account.updated", + "links": { + "actor": "https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "resource_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "account", + "sid": "AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "api", + "source_ip_address": "10.86.6.250", + "url": "https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "events": [], + "meta": { + "first_page_url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://monitor.twilio.com/v1/Events?PageSize=50&Page=0" } } } @@ -753,10 +972,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvent" } } }, @@ -764,11 +980,5 @@ { "url": "https://monitor.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 7e17614e..59ab4391 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "notify.v1.service.binding": { "type": "object", @@ -420,12 +426,17 @@ "description": "Callback configuration that enables delivery callbacks, default false" } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "user_binding_enum_binding_type": { + "type": "string", + "enum": [ + "apn", + "gcm", + "sms", + "fcm", + "facebook-messenger", + "alexa" + ] } } }, @@ -442,7 +453,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -452,7 +463,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -461,8 +472,8 @@ "binding_type", "address" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -498,6 +509,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service.binding" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73", + "binding_type": "apn", + "credential_sid": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "endpoint": "26607274", + "identity": "24987039", + "notification_protocol_version": "3", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tags": [ + "26607274" + ], + "links": { + "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039" + }, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -509,10 +544,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", @@ -552,10 +584,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteBinding" } }, "/v1/Services/{ServiceSid}/Bindings": { @@ -564,7 +593,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -573,8 +602,8 @@ "binding_type", "address" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -598,6 +627,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service.binding" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73", + "binding_type": "apn", + "credential_sid": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "endpoint": "26607274", + "identity": "24987039", + "notification_protocol_version": "3", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tags": [ + "26607274" + ], + "links": { + "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039" + }, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -610,9 +663,6 @@ } ], "operationId": "CreateBinding", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -661,6 +711,21 @@ "BindingType", "Address" ] + }, + "examples": { + "create": { + "value": { + "Address": "address", + "BindingType": "apn", + "CredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Endpoint": "endpoint", + "Identity": "24987039", + "NotificationProtocolVersion": "notification_protocol_version", + "Tag": [ + "tag" + ] + } + } } } } @@ -708,6 +773,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -719,6 +796,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "tag" + ] + }, + "readFull": { + "value": [ + "tag" + ] + } } }, { @@ -764,16 +853,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -782,17 +873,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "bindings": [], + "meta": { + "first_page_url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0", + "key": "bindings", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "bindings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73", + "binding_type": "apn", + "credential_sid": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "endpoint": "26607274", + "identity": "24987039", + "notification_protocol_version": "3", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tags": [ + "26607274" + ], + "links": { + "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039" + }, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0", + "key": "bindings", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0" } } } @@ -807,10 +947,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBinding" } }, "/v1/Credentials": { @@ -819,7 +956,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -874,16 +1011,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -892,17 +1031,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credentials": [ + { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" + } + } + }, + "readEmpty": { + "value": { + "credentials": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0", + "next_page_url": null, + "key": "credentials" } } } @@ -917,10 +1095,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -930,6 +1105,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.credential" + }, + "examples": { + "create": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -942,9 +1131,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -985,6 +1171,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -997,7 +1190,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1028,6 +1221,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.credential" + }, + "examples": { + "fetch": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1039,10 +1246,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -1066,6 +1270,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.credential" + }, + "examples": { + "update": { + "value": { + "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test slow create", + "type": "apn", + "sandbox": "False", + "date_created": "2015-10-07T17:50:01Z", + "date_updated": "2015-10-07T17:50:01Z", + "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1078,9 +1296,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1113,6 +1328,13 @@ "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } @@ -1144,10 +1366,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Notifications": { @@ -1156,15 +1375,15 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "priority", "title" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1188,6 +1407,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service.notification" + }, + "examples": { + "create": { + "value": { + "sid": "NTb8021351170b4e1286adaac3fdd6d082", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "IS699b53e02da45a1ba9d13b7d7d2766af", + "date_created": "2016-03-24T23:42:28Z", + "identities": [ + "jing" + ], + "tags": [], + "segments": [], + "priority": "high", + "ttl": 2419200, + "title": "test", + "body": "body", + "sound": null, + "action": null, + "data": null, + "apn": null, + "fcm": null, + "gcm": null, + "sms": null, + "facebook_messenger": null, + "alexa": null + } + }, + "createDirectNotification": { + "value": { + "sid": "NTb8021351170b4e1286adaac3fdd6d082", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "IS699b53e02da45a1ba9d13b7d7d2766af", + "date_created": "2016-03-24T23:42:28Z", + "identities": [], + "tags": [], + "segments": [], + "priority": "high", + "ttl": 2419200, + "title": null, + "body": "body", + "sound": null, + "action": null, + "data": null, + "apn": null, + "fcm": null, + "gcm": null, + "sms": null, + "facebook_messenger": null, + "alexa": null + } + } } } }, @@ -1200,9 +1471,6 @@ } ], "operationId": "CreateNotification", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1289,6 +1557,23 @@ "description": "A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel." } } + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "Body": "body", + "Priority": "high", + "Title": "test", + "DeliveryCallbackUrl": "hello" + } + }, + "createDirectNotification": { + "value": { + "ToBinding": "{\"binding_type\":\"apn\", \"address\":\"0efb85d06b3cc1bf290545fde4775a929d46b3541aaa4aa167e420b6c8b0ff15\"}", + "Body": "body" + } + } } } } @@ -1309,20 +1594,20 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "binding": "{service_sid: sid}", "notification": "{service_sid: sid}", - "notify/v1/user": "{service_sid: sid}", - "notify/v1/segment": "{service_sid: sid}" - } + "user": "{service_sid: sid}", + "segment": "{service_sid: sid}" + }, + "pathType": "list" }, "post": { "description": "", @@ -1332,6 +1617,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "messaging_service_sid": null, + "facebook_messenger_page_id": "4", + "alexa_skill_id": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + } } } }, @@ -1344,9 +1661,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1423,6 +1737,24 @@ "description": "Callback configuration that enables delivery callbacks, default false" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "ApnCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GcmCredentialSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FacebookMessengerPageId": "4", + "DefaultApnNotificationProtocolVersion": "3", + "DefaultGcmNotificationProtocolVersion": "3", + "DefaultFcmNotificationProtocolVersion": "3", + "LogEnabled": "True", + "Type": "S", + "DeliveryCallbackUrl": "Hello", + "DeliveryCallbackEnabled": "True" + } + } } } } @@ -1482,16 +1814,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1500,18 +1834,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "next_page_url": null, + "key": "services" + }, + "services": [ + { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "messaging_service_sid": null, + "facebook_messenger_page_id": "4", + "alexa_skill_id": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0", + "next_page_url": null, + "key": "services" + }, + "services": [] } } } @@ -1525,10 +1916,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -1537,20 +1925,20 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "binding": "{service_sid: sid}", "notification": "{service_sid: sid}", - "notify/v1/user": "{service_sid: sid}", - "notify/v1/segment": "{service_sid: sid}" - } + "user": "{service_sid: sid}", + "segment": "{service_sid: sid}" + }, + "pathType": "instance" }, "delete": { "description": "", @@ -1578,10 +1966,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "get": { "description": "", @@ -1605,6 +1990,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "messaging_service_sid": null, + "facebook_messenger_page_id": "4", + "alexa_skill_id": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + } } } }, @@ -1616,10 +2033,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "post": { "description": "", @@ -1643,6 +2057,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/notify.v1.service" + }, + "examples": { + "update": { + "value": { + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c", + "date_created": "2016-03-09T20:22:31Z", + "date_updated": "2016-03-09T20:22:31Z", + "apn_credential_sid": null, + "gcm_credential_sid": null, + "fcm_credential_sid": null, + "default_apn_notification_protocol_version": "3", + "default_gcm_notification_protocol_version": "3", + "default_fcm_notification_protocol_version": "3", + "default_alexa_notification_protocol_version": "3", + "messaging_service_sid": null, + "alexa_skill_id": null, + "facebook_messenger_page_id": "4", + "log_enabled": true, + "type": "S", + "delivery_callback_url": "Hello", + "delivery_callback_enabled": true, + "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings", + "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications", + "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments", + "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users" + } + } + } } } }, @@ -1655,9 +2101,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1734,6 +2177,24 @@ "description": "Callback configuration that enables delivery callbacks, default false" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "ApnCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GcmCredentialSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FacebookMessengerPageId": "4", + "DefaultApnNotificationProtocolVersion": "3", + "DefaultGcmNotificationProtocolVersion": "3", + "DefaultFcmNotificationProtocolVersion": "3", + "LogEnabled": "True", + "Type": "S", + "DeliveryCallbackUrl": "Hello", + "DeliveryCallbackEnabled": "True" + } + } } } } @@ -1745,11 +2206,5 @@ { "url": "https://notify.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_numbers_v1.json b/spec/json/twilio_numbers_v1.json index 5ae1b0fa..ce8e461b 100644 --- a/spec/json/twilio_numbers_v1.json +++ b/spec/json/twilio_numbers_v1.json @@ -1,6 +1,22 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "authorization_document_enum_status": { + "type": "string", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ] + }, "numbers.v1.bulk_eligibility": { "type": "object", "properties": { @@ -68,6 +84,28 @@ "eligible-by-manual-process" ] }, + "dependent_order_enum_status": { + "type": "string", + "enum": [ + "twilio-processing", + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ] + }, + "dependent_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, "numbers.v1.eligibility": { "type": "object", "properties": { @@ -99,12 +137,141 @@ "invalid-hosting-account-sid", "eligible" ] - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" + }, + "hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "twilio-processing", + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ] + }, + "hosted_number_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, + "numbers.v1.porting_bulk_portability": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KZ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this Portability check." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/porting_bulk_portability_enum_status", + "nullable": true, + "description": "The Status of this Portability check. One of `in-progress`, `completed` or `expired`." + }, + "datetime_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that the Portability check was created, given in ISO 8601 format." + }, + "phone_numbers": { + "type": "array", + "items": {}, + "nullable": true, + "description": "Contains a list with all the information of the requested phone numbers. Each phone number contains the following properties: `phone_number`: The phone number which portability is to be checked. `portable`: Boolean flag specifying if phone number is portable or not. `not_portable_reason`: Reason why the phone number cannot be ported into Twilio, `null` otherwise. `not_portable_reason_code`: The Portability Reason Code for the phone number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: Boolean flag specifying if PIN and account number is required for the phone number. `number_type`: The type of the requested phone number. `country` Country the phone number belongs to. `messaging_carrier` Current messaging carrier of the phone number. `voice_carrier` Current voice carrier of the phone number." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "This is the url of the request that you're trying to reach out to locate the resource." + } + } + }, + "porting_bulk_portability_enum_status": { + "type": "string", + "enum": [ + "in-progress", + "completed", + "expired" + ] + }, + "numbers.v1.porting_portability": { + "type": "object", + "properties": { + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212)." + }, + "portable": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying if phone number is portable or not." + }, + "pin_and_account_number_required": { + "type": "boolean", + "nullable": true, + "description": "Boolean flag specifying if PIN and account number is required for the phone number." + }, + "not_portable_reason": { + "type": "string", + "nullable": true, + "description": "Reason why the phone number cannot be ported into Twilio, `null` otherwise." + }, + "not_portable_reason_code": { + "type": "integer", + "nullable": true, + "description": "The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`." + }, + "number_type": { + "type": "string", + "$ref": "#/components/schemas/porting_portability_enum_number_type", + "nullable": true, + "description": "The type of the requested phone number. One of `LOCAL`, `UNKNOWN`, `MOBILE`, `TOLL-FREE`." + }, + "country": { + "type": "string", + "format": "iso-country-code", + "nullable": true, + "description": "Country the phone number belongs to." + }, + "messaging_carrier": { + "type": "string", + "nullable": true, + "description": "Current messaging carrier of the phone number" + }, + "voice_carrier": { + "type": "string", + "nullable": true, + "description": "Current voice carrier of the phone number" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "This is the url of the request that you're trying to reach out to locate the resource." + } + } + }, + "porting_portability_enum_number_type": { + "type": "string", + "enum": [ + "LOCAL", + "UNKNOWN", + "MOBILE", + "TOLL-FREE" + ] } } }, @@ -121,7 +288,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -131,11 +298,45 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "bulk_eligibilities" + "mountName": "bulk_eligibilities", + "pathType": "list" + }, + "post": { + "description": "Create a bulk eligibility check for a set of numbers that you want to host in Twilio.", + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.bulk_eligibility" + }, + "examples": { + "create": { + "value": { + "friendly_name": "Test", + "status": "QUEUED", + "date_created": "2023-05-03T03:12:30Z", + "date_completed": null, + "request_id": "ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [], + "url": "https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBulkEligibility" } }, "/v1/HostedNumber/Eligibility/Bulk/{RequestId}": { @@ -144,11 +345,11 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "bulk_eligibilities" + "mountName": "bulk_eligibilities", + "pathType": "instance" }, "get": { "description": "Fetch an eligibility bulk check that you requested to host in Twilio.", @@ -172,6 +373,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.bulk_eligibility" + }, + "examples": { + "fetch": { + "value": { + "friendly_name": "Foo", + "status": "SUCCESSFUL", + "date_created": "2023-04-24T14:47:04Z", + "date_completed": "2023-04-24T14:47:06Z", + "results": [ + { + "phone_number": "+18778894546", + "account_sid": "AC93b447ff5bd2abac37f1cbab2a871430", + "eligibility_status": "INELIGIBLE", + "eligibility_sub_status": "ALREADY_IN_TWILIO", + "ineligibility_reason": "ALREADY_IN_TWILIO_BUT_NOT_IN_USE", + "next_step": "CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS", + "voice_provider": null, + "messaging_provider": null, + "phone_number_type": "TOLL_FREE", + "hosting_order_sid": null, + "hosting_order_status": null, + "iso_country_code": "US", + "inventory_status": "in-testing", + "inventory_account_sid": "AC93b447ff5bd2abac37f1cbab2a871430" + } + ], + "url": "https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "request_id": "ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -183,10 +414,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBulkEligibility", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBulkEligibility" } }, "/v1/HostedNumber/Eligibility": { @@ -195,11 +423,299 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "eligibilities" + "mountName": "eligibilities", + "pathType": "list" + }, + "post": { + "description": "Create an eligibility check for a number that you want to host in Twilio.", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.eligibility" + }, + "examples": { + "create": { + "value": { + "results": [ + { + "phone_number": "+18778894546", + "account_sid": "AC93b447ff5bd2abac37f1cbab2a871430", + "eligibility_status": "INELIGIBLE", + "eligibility_sub_status": "ALREADY_IN_TWILIO", + "ineligibility_reason": "ALREADY_IN_TWILIO_BUT_NOT_IN_USE", + "next_step": "CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS", + "voice_provider": null, + "messaging_provider": null, + "phone_number_type": "TOLL_FREE", + "hosting_order_sid": null, + "hosting_order_status": null, + "iso_country_code": "US", + "inventory_status": "in-testing", + "inventory_account_sid": "AC93b447ff5aa2abac37e3cbab2a871430" + }, + { + "phone_number": "4565433456", + "account_sid": null, + "eligibility_status": "INELIGIBLE", + "eligibility_sub_status": "NUMBER_FORMAT_INELIGIBLE", + "ineligibility_reason": "NUMBER_FORMAT_INELIGIBLE", + "next_step": "EDIT_INELIGIBLE_NUMBER", + "voice_provider": null, + "messaging_provider": null, + "phone_number_type": null, + "hosting_order_sid": null, + "hosting_order_status": null, + "iso_country_code": null, + "inventory_status": null, + "inventory_account_sid": null + } + ] + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateEligibility" + } + }, + "/v1/Porting/Portability/{Sid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "status" + ], + "mountName": "porting_bulk_portabilities", + "pathType": "instance" + }, + "get": { + "description": "Fetch a previous portability check. This should return the current status of the validation and the result for all the numbers provided, given that they have been validated (as this process is performed asynchronously).", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies the Portability check.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KZ[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_bulk_portability" + }, + "examples": { + "fetch": { + "value": { + "sid": "KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "datetime_created": "2015-07-30T20:00:00Z", + "phone_numbers": [ + { + "phone_number": "+14153334440", + "portable": true, + "pin_and_account_number_required": true, + "not_portable_reason": null, + "not_portable_reason_code": null, + "number_type": "LOCAL", + "country": "US", + "messaging_carrier": "string", + "voice_carrier": "string" + }, + { + "phone_number": "+18002178781", + "portable": false, + "pin_and_account_number_required": false, + "not_portable_reason": "MANUAL_PORTING_AVAILABLE", + "not_portable_reason_code": 22133, + "number_type": "TOLL-FREE", + "country": "US", + "messaging_carrier": "Verizon", + "voice_carrier": "Verizon" + } + ], + "url": "https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPortingBulkPortability" + } + }, + "/v1/Porting/Portability": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "status" + ], + "mountName": "porting_bulk_portabilities", + "pathType": "list" + }, + "post": { + "description": "Allows to check if a list of phone numbers can be ported to Twilio or not. This is done asynchronous for each phone number.", + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_bulk_portability" + }, + "examples": { + "create": { + "value": { + "sid": "KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "datetime_created": "2015-07-30T20:00:00Z", + "phone_numbers": [], + "url": "https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreatePortingBulkPortability", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreatePortingBulkPortabilityRequest", + "properties": { + "PhoneNumbers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The phone numbers which portability is to be checked. This should be a list of strings. Phone numbers are in E.164 format (e.g. +16175551212). ." + } + }, + "required": [ + "PhoneNumbers" + ] + }, + "examples": { + "create": { + "value": { + "PhoneNumbers": [ + "+14153334440", + "+18002178781" + ] + } + } + } + } + } + } + } + }, + "/v1/Porting/Portability/PhoneNumber/{PhoneNumber}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "mountName": "porting_portabilities", + "pathType": "instance" + }, + "get": { + "description": "Allows to check if a single phone number can be ported to Twilio or not.", + "parameters": [ + { + "name": "PhoneNumber", + "in": "path", + "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).", + "schema": { + "type": "string", + "format": "phone-number" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_portability" + }, + "examples": { + "fetch": { + "value": { + "phone_number": "+18001234567", + "portable": false, + "pin_and_account_number_required": false, + "not_portable_reason": "MANUAL_PORTING_AVAILABLE", + "not_portable_reason_code": 22133, + "number_type": "TOLL-FREE", + "country": "US", + "messaging_carrier": "Verizon", + "voice_carrier": "Verizon", + "url": "https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/+18001234567" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPortingPortability" } } }, @@ -207,11 +723,5 @@ { "url": "https://numbers.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index 932146cd..352784e8 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -1,6 +1,84 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "numbers.v2.authorization_document": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this AuthorizationDocument." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status", + "nullable": true, + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + } + } + }, + "authorization_document_enum_status": { + "type": "string", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ] + }, "numbers.v2.regulatory_compliance.bundle": { "type": "object", "properties": { @@ -201,6 +279,154 @@ "business" ] }, + "numbers.v2.authorization_document.dependent_hosted_number_order": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this Authorization Document" + }, + "bulk_hosting_request_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BHR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder." + }, + "next_step": { + "type": "string", + "nullable": true, + "description": "The next step you need to take to complete the hosted number order and request it successfully." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Account." + }, + "incoming_phone_number_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "signing_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." + }, + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "An E164 formatted phone number hosted by this HostedNumberOrder." + }, + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } + }, + "nullable": true, + "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A human readable description of this resource, up to 64 characters." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", + "nullable": true, + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + }, + "failure_reason": { + "type": "string", + "nullable": true, + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email of the owner of this phone number that is being hosted." + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + }, + "contact_title": { + "type": "string", + "nullable": true, + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "contact_phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The contact phone number of the person authorized to sign the Authorization Document." + } + } + }, + "dependent_hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "received", + "verified", + "pending-loa", + "carrier-processing", + "completed", + "failed", + "action-required" + ] + }, "numbers.v2.regulatory_compliance.end_user": { "type": "object", "properties": { @@ -363,6 +589,160 @@ "noncompliant" ] }, + "numbers.v2.hosted_number_order": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this HostedNumberOrder." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the account." + }, + "incoming_phone_number_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) resource that represents the phone number being hosted." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "signing_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) the user needs to sign." + }, + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" + }, + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } + }, + "nullable": true, + "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A 64 character string that is a human-readable text that describes this resource." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status", + "nullable": true, + "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) section for more information on each of these statuses." + }, + "failure_reason": { + "type": "string", + "nullable": true, + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email of the owner of this phone number that is being hosted." + }, + "cc_emails": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this HostedNumberOrder." + }, + "contact_title": { + "type": "string", + "nullable": true, + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "contact_phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "bulk_hosting_request_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BHR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder." + }, + "next_step": { + "type": "string", + "nullable": true, + "description": "The next step you need to take to complete the hosted number order and request it successfully." + } + } + }, + "hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "received", + "verified", + "pending-loa", + "carrier-processing", + "completed", + "failed", + "action-required" + ] + }, "numbers.v2.regulatory_compliance.bundle.item_assignment": { "type": "object", "properties": { @@ -669,12 +1049,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -690,40 +1064,451 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { - "/v2/RegulatoryCompliance/Bundles": { + "/v2/HostedNumber/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { - "defaultOutputProperties": [ - "sid", - "regulation_sid", - "friendly_name" - ], - "pathType": "list", + "defaultOutputProperties": [], "dependentProperties": { - "evaluation": "{bundle_sid: sid}", - "item_assignment": "{bundle_sid: sid}", - "bundle_copy": "{bundle_sid: sid}", - "replace_items": "{bundle_sid: sid}" + "dependent_hosted_number_order": "{signing_document_sid: sid}" }, - "parent": "/RegulatoryCompliance" + "pathType": "instance" }, - "post": { - "description": "Create a new Bundle.", + "get": { + "description": "Fetch a specific AuthorizationDocument.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.authorization_document" + }, + "examples": { + "fetch": { + "value": { + "address_sid": "AD11111111111111111111111111111111", + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchAuthorizationDocument" + }, + "delete": { + "description": "Cancel the AuthorizationDocument request.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteAuthorizationDocument" + } + }, + "/v2/HostedNumber/AuthorizationDocuments": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "dependent_hosted_number_order": "{signing_document_sid: sid}" + }, + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "parameters": [ + { + "name": "Email", + "in": "query", + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } + } + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status" + }, + "examples": { + "readEmpty": { + "value": "signed" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListAuthorizationDocumentResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v2.authorization_document" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0" + }, + "items": [ + { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListAuthorizationDocument" + }, + "post": { + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.authorization_document" + }, + "examples": { + "create": { + "value": { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateAuthorizationDocument", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateAuthorizationDocumentRequest", + "properties": { + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "Email": { + "type": "string", + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "ContactPhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + } + }, + "required": [ + "AddressSid", + "Email", + "ContactPhoneNumber", + "HostedNumberOrderSids" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" + } + } + } + } + } + } + } + }, + "/v2/RegulatoryCompliance/Bundles": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "regulation_sid", + "friendly_name" + ], + "dependentProperties": { + "evaluation": "{bundle_sid: sid}", + "item_assignment": "{bundle_sid: sid}", + "bundle_copy": "{bundle_sid: sid}", + "replace_items": "{bundle_sid: sid}" + }, + "parent": "/RegulatoryCompliance", + "pathType": "list" + }, + "post": { + "description": "Create a new Bundle.", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + } } } }, @@ -736,9 +1521,6 @@ } ], "operationId": "CreateBundle", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -784,6 +1566,16 @@ "FriendlyName", "Email" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "RegulationSid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -799,7 +1591,21 @@ "schema": { "type": "string", "$ref": "#/components/schemas/bundle_enum_status" - } + }, + "examples": { + "readFull": { + "value": "draft" + }, + "readApprovedAuMobileWithDate": { + "value": "twilio-approved" + }, + "readApprovedAuMobileDateLess": { + "value": "twilio-approved" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "twilio-approved" + } + } }, { "name": "FriendlyName", @@ -807,6 +1613,11 @@ "description": "The string that you assigned to describe the resource. The column can contain 255 variable characters.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -818,6 +1629,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -826,6 +1642,20 @@ "description": "The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "US" + }, + "readApprovedAuMobileWithDate": { + "value": "AU" + }, + "readApprovedAuMobileDateLess": { + "value": "AU" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "JP" + } } }, { @@ -834,6 +1664,20 @@ "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "mobile" + }, + "readApprovedAuMobileWithDate": { + "value": "mobile" + }, + "readApprovedAuMobileDateLess": { + "value": "mobile" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "tollfree" + } } }, { @@ -842,6 +1686,11 @@ "description": "Indicates that the Bundle is a valid Bundle until a specified expiration date.", "schema": { "type": "boolean" + }, + "examples": { + "readApprovedAuMobileWithDate": { + "value": "true" + } } }, { @@ -878,6 +1727,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readApprovedAuMobileDateLess": { + "value": "2022-11-29T23:59:59Z" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "2022-11-29T23:59:59Z" + } } }, { @@ -886,8 +1743,557 @@ "description": "Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.", "schema": { "type": "string", - "format": "date-time" - } + "format": "date-time" + }, + "examples": { + "readApprovedJapanTollfreeDateBetween": { + "value": "2022-01-01T00:00:00Z" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListBundleResponse", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "provisionally-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2020-07-31T01:00:00Z", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readApprovedAuMobileWithDate": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "twilio-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2022-11-29T01:00:00Z", + "date_created": "2021-08-30T22:29:24Z", + "date_updated": "2021-08-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readApprovedAuMobileDateLess": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "twilio-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2022-11-29T01:00:00Z", + "date_created": "2021-08-30T22:29:24Z", + "date_updated": "2021-08-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readApprovedJapanTollfreeDateBetween": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "twilio-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2022-11-29T01:00:00Z", + "date_created": "2021-08-30T22:29:24Z", + "date_updated": "2021-08-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListBundle" + } + }, + "/v2/RegulatoryCompliance/Bundles/{Sid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "regulation_sid", + "friendly_name" + ], + "dependentProperties": { + "evaluation": "{bundle_sid: sid}", + "item_assignment": "{bundle_sid: sid}", + "bundle_copy": "{bundle_sid: sid}", + "replace_items": "{bundle_sid: sid}" + }, + "parent": "/RegulatoryCompliance", + "pathType": "instance" + }, + "get": { + "description": "Fetch a specific Bundle instance.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string that we created to identify the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + }, + "examples": { + "fetch": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": null, + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchBundle" + }, + "post": { + "description": "Updates a Bundle in an account.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string that we created to identify the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + }, + "examples": { + "update": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "evaluations": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "item_assignments": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments", + "bundle_copies": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateBundle", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateBundleRequest", + "properties": { + "Status": { + "type": "string", + "$ref": "#/components/schemas/bundle_enum_status", + "description": "The verification status of the Bundle resource." + }, + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "The URL we call to inform your application of status changes." + }, + "FriendlyName": { + "type": "string", + "description": "The string that you assigned to describe the resource." + }, + "Email": { + "type": "string", + "description": "The email address that will receive updates when the Bundle resource changes status." + } + } + }, + "examples": { + "update": { + "value": { + "Status": "draft", + "StatusCallback": "http://www.example.com", + "FriendlyName": "friendly_name", + "Email": "email" + } + } + } + } + } + } + }, + "delete": { + "description": "Delete a specific Bundle.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string that we created to identify the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteBundle" + } + }, + "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "mountName": "bundle_copies", + "pathType": "list" + }, + "post": { + "description": "Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle", + "parameters": [ + { + "name": "BundleSid", + "in": "path", + "description": "The unique string that identifies the Bundle to be copied.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": "2015-07-30T20:00:00Z", + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBundleCopy", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateBundleCopyRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "The string that you assigned to describe the copied bundle." + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Bundles Copies for a Bundle.", + "parameters": [ + { + "name": "BundleSid", + "in": "path", + "description": "The unique string that we created to identify the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -923,25 +2329,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListBundleResponse", + "title": "ListBundleCopyResponse", "properties": { "results": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -950,17 +2358,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "twilio-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2020-07-31T01:00:00Z", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -975,86 +2424,119 @@ "accountSid_authToken": [] } ], - "operationId": "ListBundle", - "x-maturity": [ - "GA" - ] + "operationId": "ListBundleCopy" } }, - "/v2/RegulatoryCompliance/Bundles/{Sid}": { + "/v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { - "defaultOutputProperties": [ - "sid", - "regulation_sid", - "friendly_name" - ], - "pathType": "instance", - "dependentProperties": { - "evaluation": "{bundle_sid: sid}", - "item_assignment": "{bundle_sid: sid}", - "bundle_copy": "{bundle_sid: sid}", - "replace_items": "{bundle_sid: sid}" - }, - "parent": "/RegulatoryCompliance" + "defaultOutputProperties": [], + "parent": "/HostedNumber/AuthorizationDocuments/{Sid}", + "pathType": "list" }, "get": { - "description": "Fetch a specific Bundle instance.", + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", "parameters": [ { - "name": "Sid", + "name": "SigningDocumentSid", "in": "path", - "description": "The unique string that we created to identify the Bundle resource.", + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" - } - } + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" }, - "description": "OK" - } - }, - "security": [ + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, { - "accountSid_authToken": [] - } - ], - "operationId": "FetchBundle", - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Updates a Bundle in an account.", - "parameters": [ + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, { - "name": "Sid", - "in": "path", - "description": "The unique string that we created to identify the Bundle resource.", + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" + "pattern": "^PN[0-9a-fA-F]{32}$" }, - "required": true + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } } ], "responses": { @@ -1062,72 +2544,109 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateBundle", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateBundleRequest", - "properties": { - "Status": { - "type": "string", - "$ref": "#/components/schemas/bundle_enum_status", - "description": "The verification status of the Bundle resource." - }, - "StatusCallback": { - "type": "string", - "format": "uri", - "description": "The URL we call to inform your application of status changes." - }, - "FriendlyName": { - "type": "string", - "description": "The string that you assigned to describe the resource." + "type": "object", + "title": "ListDependentHostedNumberOrderResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/numbers.v2.authorization_document.dependent_hosted_number_order" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "items": [] + } }, - "Email": { - "type": "string", - "description": "The email address that will receive updates when the Bundle resource changes status." + "readFull": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "failure_reason": "", + "contact_title": "contact_title_test", + "contact_phone_number": "+12344444444", + "bulk_hosting_request_sid": "BHR1111111111111111111111111111111", + "next_step": "Test" + } + ] + } } } } - } - } - } - }, - "delete": { - "description": "Delete a specific Bundle.", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The unique string that we created to identify the Bundle resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "description": "OK" } }, "security": [ @@ -1135,47 +2654,48 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBundle", - "x-maturity": [ - "GA" - ] + "operationId": "ListDependentHostedNumberOrder" } }, - "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies": { - "servers": [ - { - "url": "https://numbers.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/RegulatoryCompliance/Bundles/{Sid}", - "mountName": "bundle_copies" - }, - "post": { - "description": "Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle", - "parameters": [ - { - "name": "BundleSid", - "in": "path", - "description": "The unique string that identifies the Bundle to be copied.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" - }, - "required": true - } + "/v2/RegulatoryCompliance/EndUsers": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name" ], + "parent": "/RegulatoryCompliance", + "pathType": "list" + }, + "post": { + "description": "Create a new End User.", "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" + }, + "examples": { + "create": { + "value": { + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "type": "individual", + "attributes": { + "email": "foobar@twilio.com" + }, + "date_created": "2019-07-30T21:57:45Z", + "date_updated": "2019-07-30T21:57:45Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1187,20 +2707,38 @@ "accountSid_authToken": [] } ], - "operationId": "CreateBundleCopy", - "x-maturity": [ - "Beta" - ], + "operationId": "CreateEndUser", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateBundleCopyRequest", + "title": "CreateEndUserRequest", "properties": { "FriendlyName": { "type": "string", - "description": "The string that you assigned to describe the copied bundle." + "description": "The string that you assigned to describe the resource." + }, + "Type": { + "type": "string", + "$ref": "#/components/schemas/end_user_enum_type", + "description": "The type of end user of the Bundle resource - can be `individual` or `business`." + }, + "Attributes": { + "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types." + } + }, + "required": [ + "FriendlyName", + "Type" + ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "individual", + "Attributes": "{}" } } } @@ -1209,20 +2747,8 @@ } }, "get": { - "description": "Retrieve a list of all Bundles Copies for a Bundle.", + "description": "Retrieve a list of all End User for an account.", "parameters": [ - { - "name": "BundleSid", - "in": "path", - "description": "The unique string that we created to identify the Bundle resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" - }, - "required": true - }, { "name": "PageSize", "in": "query", @@ -1257,25 +2783,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListBundleCopyResponse", + "title": "ListEndUserResponse", "properties": { "results": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1284,17 +2812,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "type": "individual", + "attributes": { + "email": "foobar@twilio.com" + }, + "date_created": "2019-07-30T21:57:45Z", + "date_updated": "2019-07-30T21:57:45Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1309,39 +2878,66 @@ "accountSid_authToken": [] } ], - "operationId": "ListBundleCopy", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEndUser" } }, - "/v2/RegulatoryCompliance/EndUsers": { + "/v2/RegulatoryCompliance/EndUsers/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, - "post": { - "description": "Create a new End User.", + "get": { + "description": "Fetch specific End User Instance.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify the End User resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IT[0-9a-fA-F]{32}$" + }, + "required": true + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" + }, + "examples": { + "fetch": { + "value": { + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "type": "individual", + "attributes": { + "email": "foobar@twilio.com" + }, + "date_created": "2019-07-30T21:57:45Z", + "date_updated": "2019-07-30T21:57:45Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -1349,41 +2945,132 @@ "accountSid_authToken": [] } ], - "operationId": "CreateEndUser", - "x-maturity": [ - "GA" + "operationId": "FetchEndUser" + }, + "post": { + "description": "Update an existing End User.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify the End User resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IT[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" + }, + "examples": { + "update": { + "value": { + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "type": "individual", + "attributes": { + "email": "foobar@twilio.com" + }, + "date_created": "2019-07-30T21:57:45Z", + "date_updated": "2019-07-30T21:57:45Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "UpdateEndUser", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateEndUserRequest", + "title": "UpdateEndUserRequest", "properties": { "FriendlyName": { "type": "string", "description": "The string that you assigned to describe the resource." }, - "Type": { - "type": "string", - "$ref": "#/components/schemas/end_user_enum_type", - "description": "The type of end user of the Bundle resource - can be `individual` or `business`." - }, "Attributes": { "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types." } - }, - "required": [ - "FriendlyName", - "Type" - ] + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } } }, + "delete": { + "description": "Delete a specific End User.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify the End User resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IT[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteEndUser" + } + }, + "/v2/RegulatoryCompliance/EndUserTypes": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name" + ], + "parent": "/RegulatoryCompliance", + "pathType": "list" + }, "get": { - "description": "Retrieve a list of all End User for an account.", + "description": "Retrieve a list of all End-User Types.", "parameters": [ { "name": "PageSize", @@ -1419,25 +3106,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListEndUserResponse", + "title": "ListEndUserTypeResponse", "properties": { - "results": { + "end_user_types": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1446,17 +3135,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "end_user_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" + } + } + }, + "readFull": { + "value": { + "end_user_types": [ + { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "machine_name": "machine_name", + "fields": [ + { + "friendly_name": "Business Purpose", + "machine_name": "business_purpose", + "constraint": "String" + }, + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" } } } @@ -1471,39 +3207,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUserType" } }, - "/v2/RegulatoryCompliance/EndUsers/{Sid}": { + "/v2/RegulatoryCompliance/EndUserTypes/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, "get": { - "description": "Fetch specific End User Instance.", + "description": "Fetch a specific End-User Type Instance.", "parameters": [ { "name": "Sid", "in": "path", - "description": "The unique string created by Twilio to identify the End User resource.", + "description": "The unique string that identifies the End-User Type resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IT[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -1513,7 +3243,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + }, + "examples": { + "fetch": { + "value": { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "machine_name": "machine_name", + "fields": [ + { + "friendly_name": "Business Purpose", + "machine_name": "business_purpose", + "constraint": "String" + }, + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1525,37 +3277,213 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUserType" + } + }, + "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "pathType": "list" }, "post": { - "description": "Update an existing End User.", + "description": "Creates an evaluation for a bundle", "parameters": [ { - "name": "Sid", + "name": "BundleSid", "in": "path", - "description": "The unique string created by Twilio to identify the End User resource.", + "description": "The unique string that identifies the Bundle resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IT[0-9a-fA-F]{32}$" + "pattern": "^BU[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + }, + "examples": { + "create": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1563,80 +3491,23 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateEndUser", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateEndUserRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "The string that you assigned to describe the resource." - }, - "Attributes": { - "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types." - } - } - } - } - } - } + "operationId": "CreateEvaluation" }, - "delete": { - "description": "Delete a specific End User.", + "get": { + "description": "Retrieve a list of Evaluations associated to the Bundle resource.", "parameters": [ { - "name": "Sid", + "name": "BundleSid", "in": "path", - "description": "The unique string created by Twilio to identify the End User resource.", + "description": "The unique string that identifies the Bundle resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IT[0-9a-fA-F]{32}$" + "pattern": "^BU[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteEndUser", - "x-maturity": [ - "GA" - ] - } - }, - "/v2/RegulatoryCompliance/EndUserTypes": { - "servers": [ - { - "url": "https://numbers.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "friendly_name" - ], - "pathType": "list", - "parent": "/RegulatoryCompliance" - }, - "get": { - "description": "Retrieve a list of all End-User Types.", - "parameters": [ + }, { "name": "PageSize", "in": "query", @@ -1671,25 +3542,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListEndUserTypeResponse", + "title": "ListEvaluationResponse", "properties": { - "end_user_types": { + "results": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1698,17 +3571,206 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1723,36 +3785,47 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvaluation" } }, - "/v2/RegulatoryCompliance/EndUserTypes/{Sid}": { + "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ - "sid", - "friendly_name" + "sid" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "pathType": "instance" }, "get": { - "description": "Fetch a specific End-User Type Instance.", + "description": "Fetch specific Evaluation Instance.", "parameters": [ + { + "name": "BundleSid", + "in": "path", + "description": "The unique string that we created to identify the Bundle resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "The unique string that identifies the End-User Type resource.", + "description": "The unique string that identifies the Evaluation resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^EL[0-9a-fA-F]{32}$" }, "required": true } @@ -1762,7 +3835,171 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" + "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + }, + "examples": { + "fetch": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, @@ -1774,52 +4011,78 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvaluation" } }, - "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations": { + "/v2/HostedNumber/Orders/{Sid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "parent": "/RegulatoryCompliance/Bundles/{Sid}" + "defaultOutputProperties": [], + "mountName": "hosted_number_orders", + "pathType": "instance" }, - "post": { - "description": "Creates an evaluation for a bundle", + "get": { + "description": "Fetch a specific HostedNumberOrder.", "parameters": [ { - "name": "BundleSid", + "name": "Sid", "in": "path", - "description": "The unique string that identifies the Bundle resource.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$ref": "#/components/schemas/numbers.v2.hosted_number_order" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "failure_reason": "", + "bulk_hosting_request_sid": "BHR1111111111111111111111111111111", + "next_step": "next_step", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_title": "contact_title_test", + "contact_phone_number": "+12344444444" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -1827,25 +4090,116 @@ "accountSid_authToken": [] } ], - "operationId": "CreateEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchHostedNumberOrder" }, - "get": { - "description": "Retrieve a list of Evaluations associated to the Bundle resource.", + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", "parameters": [ { - "name": "BundleSid", + "name": "Sid", "in": "path", - "description": "The unique string that identifies the Bundle resource.", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteHostedNumberOrder" + } + }, + "/v2/HostedNumber/Orders": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "mountName": "hosted_number_orders", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "parameters": [ + { + "name": "Status", + "in": "query", + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "SmsCapability", + "in": "query", + "description": "Whether the SMS capability will be hosted on our platform. Can be `true` of `false`.", + "schema": { + "type": "boolean" + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "example" + } + } }, { "name": "PageSize", @@ -1881,25 +4235,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListEvaluationResponse", + "title": "ListHostedNumberOrderResponse", "properties": { - "results": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$ref": "#/components/schemas/numbers.v2.hosted_number_order" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1908,18 +4264,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "failure_reason": "", + "friendly_name": "friendly_name", + "bulk_hosting_request_sid": "BHR1111111111111111111111111111111", + "next_step": "next_step", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_title": "contact_title_test", + "contact_phone_number": "+12344444444" + } + ] } } } @@ -1933,64 +4345,74 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvaluation", - "x-maturity": [ - "GA" - ] - } - }, - "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}": { - "servers": [ - { - "url": "https://numbers.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "instance", - "parent": "/RegulatoryCompliance/Bundles/{Sid}" + "operationId": "ListHostedNumberOrder" }, - "get": { - "description": "Fetch specific Evaluation Instance.", - "parameters": [ - { - "name": "BundleSid", - "in": "path", - "description": "The unique string that we created to identify the Bundle resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "The unique string that identifies the Evaluation resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^EL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], + "post": { + "description": "Host a phone number's capability on Twilio's platform.", "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$ref": "#/components/schemas/numbers.v2.hosted_number_order" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "bulk_hosting_request_sid": "BHR1111111111111111111111111111111", + "next_step": "next_step", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_title": "contact_title_test", + "contact_phone_number": "+12344444444" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "contact_title": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "bulk_hosting_request_sid": "BHR1111111111111111111111111111111", + "next_step": "next_step", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_phone_number": "+12344444444" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1998,10 +4420,152 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "CreateHostedNumberOrder", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateHostedNumberOrderRequest", + "properties": { + "PhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + }, + "ContactPhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "AccountSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." + }, + "FriendlyName": { + "type": "string", + "description": "A 64 character string that is a human readable text that describes this resource." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsCapability": { + "type": "boolean", + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "StatusCallbackUrl": { + "type": "string", + "format": "uri", + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + }, + "StatusCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." + }, + "SmsApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + } + }, + "required": [ + "PhoneNumber", + "ContactPhoneNumber", + "AddressSid", + "Email" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "AD11111111111111111111111111111111", + "PhoneNumber": "+14153608311", + "ContactPhoneNumber": "+12344444444", + "ContactTitle": "contact_title_test", + "Email": "test@twilio.com" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "PhoneNumber": "+14153608311", + "ContactPhoneNumber": "+12344444444", + "Email": "test@twilio.com", + "AddressSid": "AD11111111111111111111111111111111" + } + } + } + } + } + } } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments": { @@ -2010,13 +4574,13 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "parent": "/RegulatoryCompliance/Bundles/{Sid}" + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Assigned Item.", @@ -2040,6 +4604,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2052,9 +4628,6 @@ } ], "operationId": "CreateItemAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2073,6 +4646,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2136,16 +4716,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2154,17 +4736,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2179,10 +4798,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListItemAssignment" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}": { @@ -2191,13 +4807,13 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance/Bundles/{Sid}" + "parent": "/RegulatoryCompliance/Bundles/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch specific Assigned Item Instance.", @@ -2233,6 +4849,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "bundle_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2244,10 +4872,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchItemAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -2287,10 +4912,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteItemAssignment" } }, "/v2/RegulatoryCompliance/Regulations": { @@ -2299,14 +4921,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Regulations.", @@ -2318,6 +4940,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/regulation_enum_end_user_type" + }, + "examples": { + "readEmpty": { + "value": "business" + } } }, { @@ -2326,6 +4953,11 @@ "description": "The ISO country code of the phone number's country.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "US" + } } }, { @@ -2334,6 +4966,11 @@ "description": "The type of phone number that the regulatory requiremnt is restricting.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "mobile" + } } }, { @@ -2379,16 +5016,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2397,17 +5036,84 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&EndUserType=business&NumberType=mobile&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&EndUserType=business&NumberType=mobile&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Australia: Local - Individual", + "iso_country": "AU", + "number_type": "local", + "end_user_type": "individual", + "requirements": { + "end_user": [ + { + "name": "Individual", + "type": "individual", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual", + "fields": [ + "first_name", + "last_name" + ] + } + ], + "supporting_document": [ + [ + { + "name": "Address", + "type": "document", + "description": "The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required.", + "accepted_documents": [ + { + "name": "Address Validation", + "type": "address", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address", + "fields": [] + } + ] + } + ] + ] + }, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2422,10 +5128,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRegulation", - "x-maturity": [ - "GA" - ] + "operationId": "ListRegulation" } }, "/v2/RegulatoryCompliance/Regulations/{Sid}": { @@ -2434,14 +5137,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, "get": { "description": "Fetch specific Regulation Instance.", @@ -2465,6 +5168,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.regulation" + }, + "examples": { + "fetch": { + "value": { + "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Australia: Local - Individual", + "iso_country": "AU", + "number_type": "local", + "end_user_type": "individual", + "requirements": { + "end_user": [ + { + "name": "Individual", + "type": "individual", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual", + "fields": [ + "first_name", + "last_name" + ] + } + ], + "supporting_document": [ + [ + { + "name": "Address", + "type": "document", + "description": "The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required.", + "accepted_documents": [ + { + "name": "Address Validation", + "type": "address", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address", + "fields": [] + } + ] + } + ] + ] + }, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2476,10 +5221,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRegulation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRegulation" } }, "/v2/RegulatoryCompliance": { @@ -2488,7 +5230,7 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -2500,12 +5242,12 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/RegulatoryCompliance/Bundles/{Sid}", - "className": "replace_items" + "className": "replace_items", + "pathType": "list" }, "post": { "description": "Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param)", @@ -2529,6 +5271,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.replace_items" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": "2015-07-30T20:00:00Z", + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -2541,9 +5299,6 @@ } ], "operationId": "CreateReplaceItems", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2562,6 +5317,13 @@ "required": [ "FromBundleSid" ] + }, + "examples": { + "create": { + "value": { + "FromBundleSid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } @@ -2574,14 +5336,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "list" }, "post": { "description": "Create a new Supporting Document.", @@ -2591,6 +5353,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" + }, + "examples": { + "create": { + "value": { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2603,9 +5385,6 @@ } ], "operationId": "CreateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2629,6 +5408,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "type", + "Attributes": "{}" + } + } } } } @@ -2680,16 +5468,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2698,17 +5488,93 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readRejectedDocument": { + "value": { + "results": [ + { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "twilio-rejected", + "failure_reason": "Some failure reason.", + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2723,10 +5589,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocument" } }, "/v2/RegulatoryCompliance/SupportingDocuments/{Sid}": { @@ -2735,14 +5598,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, "get": { "description": "Fetch specific Supporting Document Instance.", @@ -2766,6 +5629,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" + }, + "examples": { + "fetch": { + "value": { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2777,10 +5660,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocument" }, "post": { "description": "Update an existing Supporting Document.", @@ -2804,6 +5684,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" + }, + "examples": { + "update": { + "value": { + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "mime_type": "mime_type", + "status": "draft", + "failure_reason": null, + "type": "type", + "attributes": { + "first_name": "foo", + "last_name": "bar" + }, + "date_created": "2019-07-31T02:11:52Z", + "date_updated": "2019-07-31T02:11:52Z", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2816,9 +5716,6 @@ } ], "operationId": "UpdateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2834,6 +5731,14 @@ "description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -2865,10 +5770,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSupportingDocument" } }, "/v2/RegulatoryCompliance/SupportingDocumentTypes": { @@ -2877,14 +5779,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "list", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Supporting Document Types.", @@ -2932,16 +5834,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2950,17 +5854,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "supporting_document_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" + } + } + }, + "readFull": { + "value": { + "supporting_document_types": [ + { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Passport", + "machine_name": "passport", + "fields": [ + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" } } } @@ -2975,10 +5921,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocumentType" } }, "/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}": { @@ -2987,14 +5930,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "instance", - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, "get": { "description": "Fetch a specific Supporting Document Type Instance.", @@ -3015,6 +5958,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type" + }, + "examples": { + "fetch": { + "value": { + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Passport", + "machine_name": "passport", + "fields": [ + { + "friendly_name": "Last Name", + "machine_name": "last_name", + "constraint": "String" + } + ], + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3026,10 +5986,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocumentType" } } }, @@ -3037,15 +5994,5 @@ { "url": "https://numbers.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_oauth_v1.json b/spec/json/twilio_oauth_v1.json index 4118a484..4b44226c 100644 --- a/spec/json/twilio_oauth_v1.json +++ b/spec/json/twilio_oauth_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "oauth.v1.certs": { "type": "object", @@ -212,12 +218,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -233,7 +233,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -243,13 +243,13 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "keys" ], - "pathType": "instance", - "mountName": "oauth" + "mountName": "oauth", + "pathType": "instance" }, "get": { "description": "Fetches public JWKs", @@ -259,6 +259,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.certs" + }, + "examples": { + "fetch": { + "value": { + "keys": [ + { + "alg": "ES256", + "kid": "IC10c8172f35dd36f20d9ed2fcc0b818c7", + "key_ops": [], + "use": "sig", + "crv": "P-256", + "x": "hrJ4NKauVYBiREgIY_EPPj10zHIiOHeIf3-LGODt_KM", + "y": "c3IcyhpvfMIMpqd_ku9Q_4n20nMlelUF-zSmRXEIFEU", + "kty": "EC" + } + ], + "url": "https://oauth.twilio.com/v1/certs" + } + } } } }, @@ -270,10 +289,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCerts", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCerts" } }, "/v1/device/code": { @@ -282,7 +298,7 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "device_code", @@ -292,8 +308,8 @@ "expires_in", "interval" ], - "pathType": "list", - "mountName": "device_code" + "mountName": "device_code", + "pathType": "list" }, "post": { "description": "Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant", @@ -303,6 +319,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.device_code" + }, + "examples": { + "create": { + "value": { + "device_code": "LiwuhE0bIhqemK6sd34tXfobVCR9yrk0", + "user_code": "Hkf1WaID3", + "verification_uri": "v1/oauth2/device/activate", + "verification_uri_complete": "v1/oauth2/device/activate?user_code=Hkf1WaID3", + "expires_in": 299, + "interval": 5 + } + } } } }, @@ -315,9 +343,6 @@ } ], "operationId": "CreateDeviceCode", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -348,6 +373,19 @@ "ClientSid", "Scopes" ] + }, + "examples": { + "create": { + "value": { + "ClientSid": "OQ693217fa7610373e7762f06645058bac", + "Scopes": [ + "test-scope" + ], + "Audiences": [ + "http://dev.twilio.com/" + ] + } + } } } } @@ -360,7 +398,7 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "issuer", @@ -376,8 +414,8 @@ "scopes_supported", "claims_supported" ], - "pathType": "instance", - "mountName": "openid_discovery" + "mountName": "openid_discovery", + "pathType": "instance" }, "get": { "description": "Fetch configuration details about the OpenID Connect Authorization Server", @@ -387,6 +425,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.openid_discovery" + }, + "examples": { + "fetch": { + "value": { + "issuer": "https://iam.twilio.com", + "authorization_endpoint": "https://oauth.twilio.com/oauth2/authorize", + "device_authorization_endpoint": "https://oauth.twilio.com/oauth2/device/authorize", + "token_endpoint": "https://oauth.twilio.com/oauth2/token", + "userinfo_endpoint": "https://oauth.twilio.com/oauth2/userinfo", + "revocation_endpoint": "https://oauth.twilio.com/oauth2/revoke", + "jwk_uri": "https://oauth.twilio.com/oauth2/certs", + "response_type_supported": [ + "code", + "token" + ], + "subject_type_supported": [ + "account_sid", + "user_sid" + ], + "id_token_signing_alg_values_supported": [ + "ECDSA", + "RSA256" + ], + "scopes_supported": [ + "openid", + "profile", + "email" + ], + "claims_supported": [ + "act", + "aud", + "cid", + "device_id", + "exp", + "jti", + "iat", + "iss", + "nbf", + "scp", + "sub" + ], + "url": "https://oauth.twilio.com/v1/.well-known/openid-configuration" + } + } } } }, @@ -398,10 +480,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOpenidDiscovery", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOpenidDiscovery" } }, "/v1/token": { @@ -410,7 +489,7 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "access_token", @@ -426,6 +505,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.token" + }, + "examples": { + "create": { + "value": { + "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "refresh_token": "ghjbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "id_token": "eyJhbdGciOiIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "refresh_token_expires_at": "2015-07-31T04:00:00Z", + "access_token_expires_at": "2015-07-31T04:00:00Z" + } + } } } }, @@ -438,9 +528,6 @@ } ], "operationId": "CreateToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -485,6 +572,20 @@ "GrantType", "ClientSid" ] + }, + "examples": { + "create": { + "value": { + "GrantType": "authorization_code", + "ClientSid": "OQ09708361261756db8c0b555d36f55a65", + "ClientSecret": "client_secret", + "Code": "dfyguyhuijikokje456rt7y8uioklj", + "CodeVerifier": "code_verifier", + "DeviceCode": "device_code", + "RefreshToken": "refresh_token", + "DeviceId": "device_id" + } + } } } } @@ -497,13 +598,13 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "user_sid" ], - "pathType": "instance", - "mountName": "user_info" + "mountName": "user_info", + "pathType": "instance" }, "get": { "description": "Retrieves the consented UserInfo and other claims about the logged-in subject (end-user).", @@ -513,6 +614,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.user_info" + }, + "examples": { + "fetch": { + "value": { + "user_sid": "US57cc2449f1b38ed85cf1a43cd8166349", + "first_name": "Mafalda", + "last_name": "Rolfson", + "friendly_name": "mafalda.rolfson+oBgz@ct.sink.twilio.com", + "email": "mafalda.rolfson+oBgz@ct.sink.twilio.com", + "url": "https://oauth.twilio.com/v1/userinfo" + } + } } } }, @@ -524,10 +637,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserInfo", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserInfo" } } }, @@ -535,11 +645,5 @@ { "url": "https://oauth.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index cfc0e045..3205c5e5 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "preview.deployed_devices.fleet.certificate": { "type": "object", @@ -323,653 +329,438 @@ } } }, - "preview.hosted_numbers.authorization_document": { + "preview.marketplace.available_add_on": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this AuthorizationDocument." - }, - "address_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", + "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + "description": "The unique string that we created to identify the AvailableAddOn resource." }, - "status": { + "friendly_name": { "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", "nullable": true, - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + "description": "The string that you assigned to describe the resource." }, - "email": { + "description": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "cc_emails": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + "description": "A short description of the Add-on's functionality." }, - "date_created": { + "pricing_type": { "type": "string", - "format": "date-time", "nullable": true, - "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + "description": "How customers are charged for using this Add-on." }, - "date_updated": { - "type": "string", - "format": "date-time", + "configuration_schema": { "nullable": true, - "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + "description": "The JSON object with the configuration that must be provided when installing a given Add-on." }, "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", - "nullable": true + "nullable": true, + "description": "The URLs of related resources." } } }, - "authorization_document_enum_status": { - "type": "string", - "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" - ] - }, - "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { + "preview.marketplace.available_add_on.available_add_on_extension": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", + "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies this Authorization Document" + "description": "The unique string that we created to identify the AvailableAddOnExtension resource." }, - "account_sid": { + "available_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^XB[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Account." + "description": "The SID of the AvailableAddOn resource to which this extension applies." }, - "incoming_phone_number_sid": { + "friendly_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." + "description": "The string that you assigned to describe the resource." }, - "address_sid": { + "product_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + "description": "The name of the Product this Extension is used within." }, - "signing_document_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." + "description": "An application-defined string that uniquely identifies the resource." }, - "phone_number": { + "url": { "type": "string", - "format": "phone-number", + "format": "uri", "nullable": true, - "description": "An E164 formatted phone number hosted by this HostedNumberOrder." + "description": "The absolute URL of the resource." + } + } + }, + "preview.marketplace.installed_add_on": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'." }, - "capabilities": { - "type": "object", - "format": "phone-number-capabilities", - "properties": { - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - }, - "fax": { - "type": "boolean" - } - }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource." }, "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource, up to 64 characters." + "description": "The string that you assigned to describe the resource." }, - "unique_name": { + "description": { "type": "string", "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + "description": "A short description of the Add-on's functionality." }, - "status": { - "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", + "configuration": { "nullable": true, - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + "description": "The JSON object that represents the current configuration of installed Add-on." }, - "failure_reason": { + "unique_name": { "type": "string", "nullable": true, - "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + "description": "An application-defined string that uniquely identifies the resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "verification_attempts": { - "type": "integer", - "nullable": true, - "description": "The number of attempts made to verify ownership of the phone number that is being hosted." + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, - "email": { + "url": { "type": "string", + "format": "uri", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." + "description": "The absolute URL of the resource." }, - "cc_emails": { - "type": "array", - "items": { - "type": "string" - }, + "links": { + "type": "object", + "format": "uri-map", "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" - }, - "verification_type": { + "description": "The URLs of related resources." + } + } + }, + "preview.marketplace.installed_add_on.installed_add_on_extension": { + "type": "object", + "properties": { + "sid": { "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", "nullable": true, - "description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + "description": "The unique string that we created to identify the InstalledAddOn Extension resource." }, - "verification_document_sid": { + "installed_add_on_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", + "pattern": "^XE[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." + "description": "The SID of the InstalledAddOn resource to which this extension applies." }, - "extension": { + "friendly_name": { "type": "string", "nullable": true, - "description": "A numerical extension to be used when making the ownership verification call." + "description": "The string that you assigned to describe the resource." }, - "call_delay": { - "type": "integer", + "product_name": { + "type": "string", "nullable": true, - "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." + "description": "The name of the Product this Extension is used within." }, - "verification_code": { + "unique_name": { "type": "string", "nullable": true, - "description": "The digits passed during the ownership verification call." + "description": "An application-defined string that uniquely identifies the resource." }, - "verification_call_sids": { - "type": "array", - "items": { - "type": "string" - }, + "enabled": { + "type": "boolean", "nullable": true, - "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." + "description": "Whether the Extension will be invoked." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the resource." } } }, - "dependent_hosted_number_order_enum_status": { - "type": "string", - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ] - }, - "dependent_hosted_number_order_enum_verification_type": { - "type": "string", - "enum": [ - "phone-call", - "phone-bill" - ] - }, - "preview.hosted_numbers.hosted_number_order": { + "preview.sync.service.document": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this HostedNumberOrder." + "pattern": "^ET[0-9a-fA-F]{32}$", + "nullable": true }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the account." - }, - "incoming_phone_number_sid": { + "unique_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) resource that represents the phone number being hosted." + "nullable": true }, - "address_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "signing_document_sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) the user needs to sign." + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true }, - "phone_number": { + "url": { "type": "string", - "format": "phone-number", - "nullable": true, - "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" + "format": "uri", + "nullable": true }, - "capabilities": { + "links": { "type": "object", - "format": "phone-number-capabilities", - "properties": { - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - }, - "fax": { - "type": "boolean" - } - }, - "nullable": true, - "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "A 64 character string that is a human-readable text that describes this resource." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + "format": "uri-map", + "nullable": true }, - "status": { + "revision": { "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status", - "nullable": true, - "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) section for more information on each of these statuses." + "nullable": true }, - "failure_reason": { - "type": "string", - "nullable": true, - "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + "data": { + "nullable": true }, "date_created": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + "nullable": true }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." - }, - "verification_attempts": { - "type": "integer", - "nullable": true, - "description": "The number of attempts made to verify ownership of the phone number that is being hosted." + "nullable": true }, - "email": { + "created_by": { "type": "string", - "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." - }, - "cc_emails": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." - }, - "url": { + "nullable": true + } + } + }, + "preview.sync.service.document.document_permission": { + "type": "object", + "properties": { + "account_sid": { "type": "string", - "format": "uri", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The URL of this HostedNumberOrder." + "description": "The unique SID identifier of the Twilio Account." }, - "verification_type": { + "service_sid": { "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." + "description": "The unique SID identifier of the Sync Service Instance." }, - "verification_document_sid": { + "document_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", + "pattern": "^ET[0-9a-fA-F]{32}$", "nullable": true, - "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." + "description": "The unique SID identifier of the Sync Document to which the Permission applies." }, - "extension": { + "identity": { "type": "string", "nullable": true, - "description": "A numerical extension to be used when making the ownership verification call." + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." }, - "call_delay": { - "type": "integer", + "read": { + "type": "boolean", "nullable": true, - "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." + "description": "Boolean flag specifying whether the identity can read the Sync Document." }, - "verification_code": { - "type": "string", + "write": { + "type": "boolean", "nullable": true, - "description": "A verification code provided in the response for a user to enter when they pick up the phone call." + "description": "Boolean flag specifying whether the identity can update the Sync Document." }, - "verification_call_sids": { - "type": "array", - "items": { - "type": "string" - }, + "manage": { + "type": "boolean", "nullable": true, - "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." + "description": "Boolean flag specifying whether the identity can delete the Sync Document." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "Contains an absolute URL for this Sync Document Permission." } } }, - "hosted_number_order_enum_status": { - "type": "string", - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ] - }, - "hosted_number_order_enum_verification_type": { - "type": "string", - "enum": [ - "phone-call", - "phone-bill" - ] - }, - "preview.marketplace.available_add_on": { + "preview.sync.service": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the AvailableAddOn resource." + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true }, - "friendly_name": { + "account_sid": { "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "description": { + "friendly_name": { "type": "string", - "nullable": true, - "description": "A short description of the Add-on's functionality." + "nullable": true }, - "pricing_type": { + "date_created": { "type": "string", - "nullable": true, - "description": "How customers are charged for using this Add-on." + "format": "date-time", + "nullable": true }, - "configuration_schema": { - "nullable": true, - "description": "The JSON object with the configuration that must be provided when installing a given Add-on." + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true }, "url": { "type": "string", "format": "uri", - "nullable": true, - "description": "The absolute URL of the resource." + "nullable": true + }, + "webhook_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "reachability_webhooks_enabled": { + "type": "boolean", + "nullable": true + }, + "acl_enabled": { + "type": "boolean", + "nullable": true }, "links": { "type": "object", "format": "uri-map", - "nullable": true, - "description": "The URLs of related resources." + "nullable": true } } }, - "preview.marketplace.available_add_on.available_add_on_extension": { + "preview.sync.service.sync_list": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the AvailableAddOnExtension resource." + "pattern": "^ES[0-9a-fA-F]{32}$", + "nullable": true }, - "available_add_on_sid": { + "unique_name": { + "type": "string", + "nullable": true + }, + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the AvailableAddOn resource to which this extension applies." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." - }, - "product_name": { - "type": "string", - "nullable": true, - "description": "The name of the Product this Extension is used within." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the resource." - } - } - }, - "preview.marketplace.installed_add_on": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'." - }, - "account_sid": { + "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource." - }, - "friendly_name": { - "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." - }, - "description": { - "type": "string", - "nullable": true, - "description": "A short description of the Add-on's functionality." - }, - "configuration": { - "nullable": true, - "description": "The JSON object that represents the current configuration of installed Add-on." - }, - "unique_name": { - "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + "pattern": "^IS[0-9a-fA-F]{32}$", + "nullable": true }, "url": { "type": "string", "format": "uri", - "nullable": true, - "description": "The absolute URL of the resource." + "nullable": true }, "links": { "type": "object", "format": "uri-map", - "nullable": true, - "description": "The URLs of related resources." - } - } - }, - "preview.marketplace.installed_add_on.installed_add_on_extension": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique string that we created to identify the InstalledAddOn Extension resource." - }, - "installed_add_on_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the InstalledAddOn resource to which this extension applies." + "nullable": true }, - "friendly_name": { + "revision": { "type": "string", - "nullable": true, - "description": "The string that you assigned to describe the resource." + "nullable": true }, - "product_name": { + "date_created": { "type": "string", - "nullable": true, - "description": "The name of the Product this Extension is used within." + "format": "date-time", + "nullable": true }, - "unique_name": { + "date_updated": { "type": "string", - "nullable": true, - "description": "An application-defined string that uniquely identifies the resource." - }, - "enabled": { - "type": "boolean", - "nullable": true, - "description": "Whether the Extension will be invoked." + "format": "date-time", + "nullable": true }, - "url": { + "created_by": { "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the resource." + "nullable": true } } }, - "preview.sync.service.document": { + "preview.sync.service.sync_list.sync_list_item": { "type": "object", "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", - "nullable": true - }, - "unique_name": { - "type": "string", + "index": { + "type": "integer", "nullable": true }, "account_sid": { @@ -986,14 +777,16 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "url": { + "list_sid": { "type": "string", - "format": "uri", + "minLength": 34, + "maxLength": 34, + "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", + "url": { + "type": "string", + "format": "uri", "nullable": true }, "revision": { @@ -1019,7 +812,21 @@ } } }, - "preview.sync.service.document.document_permission": { + "sync_list_item_enum_query_result_order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "sync_list_item_enum_query_from_bound_type": { + "type": "string", + "enum": [ + "inclusive", + "exclusive" + ] + }, + "preview.sync.service.sync_list.sync_list_permission": { "type": "object", "properties": { "account_sid": { @@ -1038,13 +845,13 @@ "nullable": true, "description": "The unique SID identifier of the Sync Service Instance." }, - "document_sid": { + "list_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ET[0-9a-fA-F]{32}$", + "pattern": "^ES[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique SID identifier of the Sync Document to which the Permission applies." + "description": "The unique SID identifier of the Sync List to which the Permission applies." }, "identity": { "type": "string", @@ -1054,90 +861,34 @@ "read": { "type": "boolean", "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync Document." + "description": "Boolean flag specifying whether the identity can read the Sync List and its Items." }, "write": { "type": "boolean", "nullable": true, - "description": "Boolean flag specifying whether the identity can update the Sync Document." + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, "manage": { "type": "boolean", "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync Document." + "description": "Boolean flag specifying whether the identity can delete the Sync List." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "Contains an absolute URL for this Sync Document Permission." - } - } - }, - "preview.sync.service": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true - }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true - }, - "friendly_name": { - "type": "string", - "nullable": true - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "webhook_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "reachability_webhooks_enabled": { - "type": "boolean", - "nullable": true - }, - "acl_enabled": { - "type": "boolean", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true + "description": "Contains an absolute URL for this Sync List Permission." } } }, - "preview.sync.service.sync_list": { + "preview.sync.service.sync_map": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true }, "unique_name": { @@ -1188,11 +939,11 @@ } } }, - "preview.sync.service.sync_list.sync_list_item": { + "preview.sync.service.sync_map.sync_map_item": { "type": "object", "properties": { - "index": { - "type": "integer", + "key": { + "type": "string", "nullable": true }, "account_sid": { @@ -1209,11 +960,11 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, - "list_sid": { + "map_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", + "pattern": "^MP[0-9a-fA-F]{32}$", "nullable": true }, "url": { @@ -1244,197 +995,14 @@ } } }, - "sync_list_item_enum_query_result_order": { + "sync_map_item_enum_query_result_order": { "type": "string", "enum": [ "asc", "desc" ] }, - "sync_list_item_enum_query_from_bound_type": { - "type": "string", - "enum": [ - "inclusive", - "exclusive" - ] - }, - "preview.sync.service.sync_list.sync_list_permission": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Twilio Account." - }, - "service_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Sync Service Instance." - }, - "list_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^ES[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique SID identifier of the Sync List to which the Permission applies." - }, - "identity": { - "type": "string", - "nullable": true, - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer." - }, - "read": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can read the Sync List and its Items." - }, - "write": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." - }, - "manage": { - "type": "boolean", - "nullable": true, - "description": "Boolean flag specifying whether the identity can delete the Sync List." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "Contains an absolute URL for this Sync List Permission." - } - } - }, - "preview.sync.service.sync_map": { - "type": "object", - "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "nullable": true - }, - "unique_name": { - "type": "string", - "nullable": true - }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true - }, - "service_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true - }, - "revision": { - "type": "string", - "nullable": true - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_by": { - "type": "string", - "nullable": true - } - } - }, - "preview.sync.service.sync_map.sync_map_item": { - "type": "object", - "properties": { - "key": { - "type": "string", - "nullable": true - }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true - }, - "service_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "nullable": true - }, - "map_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^MP[0-9a-fA-F]{32}$", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "revision": { - "type": "string", - "nullable": true - }, - "data": { - "nullable": true - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_by": { - "type": "string", - "nullable": true - } - } - }, - "sync_map_item_enum_query_result_order": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - }, - "sync_map_item_enum_query_from_bound_type": { + "sync_map_item_enum_query_from_bound_type": { "type": "string", "enum": [ "inclusive", @@ -2597,1132 +2165,499 @@ "nullable": true } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } - } - }, - "info": { - "title": "Twilio - Preview", - "description": "This is the public Twilio REST API.", - "termsOfService": "https://www.twilio.com/legal/tos", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.43.2" - }, - "openapi": "3.0.1", - "paths": { - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" }, - "get": { - "description": "Fetch information about a specific Certificate credential in the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { + "preview.hosted_numbers.authorization_document": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this AuthorizationDocument." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status", + "nullable": true, + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "cc_emails": { + "type": "array", + "items": { "type": "string" }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesCertificateRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" - }, - "post": { - "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesCertificateRequest", - "properties": { - "CertificateData": { - "type": "string", - "description": "Provides a URL encoded representation of the public certificate in PEM format." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." - } - }, - "required": [ - "CertificateData" - ] - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "DeviceSid", - "in": "query", - "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListDeployedDevicesCertificateResponse", - "properties": { - "certificates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" - }, - "get": { - "description": "Fetch information about a specific Deployment in the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesDeploymentRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" - }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" - }, - "post": { - "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeploymentRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." - }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Deployments belonging to the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListDeployedDevicesDeploymentResponse", - "properties": { - "deployments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true } - ], - "operationId": "ListDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" }, - "get": { - "description": "Fetch information about a specific Device in the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDevice", - "x-maturity": [ - "Preview" + "authorization_document_enum_status": { + "type": "string", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" ] }, - "delete": { - "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "preview.hosted_numbers.authorization_document.dependent_hosted_number_order": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this Authorization Document" + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique SID identifier of the Account." + }, + "incoming_phone_number_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "signing_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder." + }, + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "An E164 formatted phone number hosted by this HostedNumberOrder." + }, + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" + } }, - "required": true + "nullable": true, + "description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A human readable description of this resource, up to 64 characters." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status", + "nullable": true, + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + }, + "failure_reason": { + "type": "string", + "nullable": true, + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "verification_attempts": { + "type": "integer", + "nullable": true, + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email of the owner of this phone number that is being hosted." + }, + "cc_emails": { + "type": "array", + "items": { "type": "string" }, - "required": true + "nullable": true, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { + "verification_type": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type", + "nullable": true, + "description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "verification_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." + }, + "extension": { + "type": "string", + "nullable": true, + "description": "A numerical extension to be used when making the ownership verification call." + }, + "call_delay": { + "type": "integer", + "nullable": true, + "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." + }, + "verification_code": { + "type": "string", + "nullable": true, + "description": "The digits passed during the ownership verification call." + }, + "verification_call_sids": { + "type": "array", + "items": { "type": "string" }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesDeviceRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." - }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." - }, - "Enabled": { - "type": "boolean", - "description": "" - } - } - } - } + "nullable": true, + "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" }, - "post": { - "description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } + "dependent_hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ] + }, + "dependent_hosted_number_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" + ] + }, + "preview.hosted_numbers.hosted_number_order": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this HostedNumberOrder." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the account." + }, + "incoming_phone_number_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) resource that represents the phone number being hosted." + }, + "address_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "signing_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) the user needs to sign." + }, + "phone_number": { + "type": "string", + "format": "phone-number", + "nullable": true, + "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212" + }, + "capabilities": { + "type": "object", + "format": "phone-number-capabilities", + "properties": { + "mms": { + "type": "boolean" + }, + "sms": { + "type": "boolean" + }, + "voice": { + "type": "boolean" + }, + "fax": { + "type": "boolean" } }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeviceRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." - }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." - }, - "Enabled": { - "type": "boolean", - "description": "" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Devices belonging to the Fleet.", - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { + "nullable": true, + "description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A 64 character string that is a human-readable text that describes this resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status", + "nullable": true, + "description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) section for more information on each of these statuses." + }, + "failure_reason": { + "type": "string", + "nullable": true, + "description": "A message that explains why a hosted_number_order went to status \"action-required\"" + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format." + }, + "verification_attempts": { + "type": "integer", + "nullable": true, + "description": "The number of attempts made to verify ownership of the phone number that is being hosted." + }, + "email": { + "type": "string", + "nullable": true, + "description": "Email of the owner of this phone number that is being hosted." + }, + "cc_emails": { + "type": "array", + "items": { "type": "string" }, - "required": true + "nullable": true, + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." }, - { - "name": "DeploymentSid", - "in": "query", - "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - } + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this HostedNumberOrder." }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } + "verification_type": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "nullable": true, + "description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`." }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } + "verification_document_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted." }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { + "extension": { + "type": "string", + "nullable": true, + "description": "A numerical extension to be used when making the ownership verification call." + }, + "call_delay": { + "type": "integer", + "nullable": true, + "description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call." + }, + "verification_code": { + "type": "string", + "nullable": true, + "description": "A verification code provided in the response for a user to enter when they pick up the phone call." + }, + "verification_call_sids": { + "type": "array", + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListDeployedDevicesDeviceResponse", - "properties": { - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] + "nullable": true, + "description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification." } - ], - "operationId": "ListDeployedDevicesDevice", - "x-maturity": [ - "Preview" + } + }, + "hosted_number_order_enum_status": { + "type": "string", + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ] + }, + "hosted_number_order_enum_verification_type": { + "type": "string", + "enum": [ + "phone-call", + "phone-bill" ] } + } + }, + "info": { + "title": "Twilio - Preview", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" }, - "/DeployedDevices/Fleets/{Sid}": { + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.0" + }, + "openapi": "3.0.1", + "paths": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "device": "{fleet_sid: sid}", - "deployment": "{fleet_sid: sid}", - "certificate": "{fleet_sid: sid}", - "key": "{fleet_sid: sid}" - } + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "Fetch information about a specific Fleet in your account.", + "description": "Fetch information about a specific Certificate credential in the Fleet.", "parameters": [ { - "name": "Sid", + "name": "FleetSid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "", "schema": { "type": "string" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3730,7 +2665,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + }, + "examples": { + "fetch": { + "value": { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3742,22 +2692,31 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesCertificate" }, "delete": { - "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "parameters": [ { - "name": "Sid", + "name": "FleetSid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "", "schema": { "type": "string" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3770,22 +2729,31 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesCertificate" }, "post": { - "description": "Update the friendly name property of a specific Fleet in your account.", + "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", "parameters": [ { - "name": "Sid", + "name": "FleetSid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "", "schema": { "type": "string" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3793,7 +2761,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + }, + "examples": { + "update": { + "value": { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3805,27 +2788,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesCertificate", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesFleetRequest", + "title": "UpdateDeployedDevicesCertificateRequest", "properties": { "FriendlyName": { "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." }, - "DefaultDeploymentSid": { + "DeviceSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + } + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } @@ -3834,31 +2822,52 @@ } } }, - "/DeployedDevices/Fleets": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "device": "{fleet_sid: sid}", - "deployment": "{fleet_sid: sid}", - "certificate": "{fleet_sid: sid}", - "key": "{fleet_sid: sid}" - } + "parent": "/Fleets/{Sid}", + "pathType": "list" }, "post": { - "description": "Create a new Fleet for scoping of deployed devices within your account.", + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + }, + "examples": { + "create": { + "value": { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3870,20 +2879,40 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateDeployedDevicesCertificate", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesFleetRequest", + "title": "CreateDeployedDevicesCertificateRequest", "properties": { + "CertificateData": { + "type": "string", + "description": "Provides a URL encoded representation of the public certificate in PEM format." + }, "FriendlyName": { "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + } + }, + "required": [ + "CertificateData" + ] + }, + "examples": { + "create": { + "value": { + "CertificateData": "12345678abcdef", + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } @@ -3892,8 +2921,28 @@ } }, "get": { - "description": "Retrieve a list of all Fleets belonging to your account.", + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "DeviceSid", + "in": "query", + "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$" + } + }, { "name": "PageSize", "in": "query", @@ -3928,25 +2977,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesFleetResponse", + "title": "ListDeployedDevicesCertificateResponse", "properties": { - "fleets": { + "certificates": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3955,17 +3006,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "certificates": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "certificates": [ + { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" } } } @@ -3980,26 +3071,23 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesCertificate" } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Fleets/{Sid}" + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "Fetch information about a specific Key credential in the Fleet.", + "description": "Fetch information about a specific Deployment in the Fleet.", "parameters": [ { "name": "FleetSid", @@ -4013,12 +3101,12 @@ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -4028,7 +3116,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + }, + "examples": { + "fetch": { + "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4040,13 +3142,10 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesDeployment" }, "delete": { - "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", "parameters": [ { "name": "FleetSid", @@ -4060,12 +3159,12 @@ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -4080,13 +3179,10 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesDeployment" }, "post": { - "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "description": "Update 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": [ { "name": "FleetSid", @@ -4100,12 +3196,12 @@ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -4115,7 +3211,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + }, + "examples": { + "update": { + "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4127,27 +3237,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesKey", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesKeyRequest", + "title": "UpdateDeployedDevicesDeploymentRequest", "properties": { "FriendlyName": { "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" }, - "DeviceSid": { + "SyncServiceSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" } } } @@ -4156,20 +3271,20 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" + "parent": "/Fleets/{Sid}", + "pathType": "list" }, "post": { - "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", "parameters": [ { "name": "FleetSid", @@ -4186,7 +3301,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + }, + "examples": { + "create": { + "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4198,27 +3327,32 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesKey", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateDeployedDevicesDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesKeyRequest", + "title": "CreateDeployedDevicesDeploymentRequest", "properties": { "FriendlyName": { "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." }, - "DeviceSid": { + "SyncServiceSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" } } } @@ -4227,7 +3361,7 @@ } }, "get": { - "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "description": "Retrieve a list of all Deployments belonging to the Fleet.", "parameters": [ { "name": "FleetSid", @@ -4238,17 +3372,6 @@ }, "required": true }, - { - "name": "DeviceSid", - "in": "query", - "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" - } - }, { "name": "PageSize", "in": "query", @@ -4283,25 +3406,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesKeyResponse", + "title": "ListDeployedDevicesDeploymentResponse", "properties": { - "keys": { + "deployments": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4310,17 +3435,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "deployments": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "deployments": [ + { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" } } } @@ -4335,38 +3499,39 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesDeployment" } }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "dependent_hosted_number_order": "{signing_document_sid: sid}" - } + "parent": "/Fleets/{Sid}", + "pathType": "instance" }, "get": { - "description": "Fetch a specific AuthorizationDocument.", + "description": "Fetch information about a specific Device in the Fleet.", "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -4376,7 +3541,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "examples": { + "fetch": { + "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4388,23 +3571,60 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesDevice" }, - "post": { - "description": "Updates a specific AuthorizationDocument.", + "delete": { + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesDevice" + }, + "post": { + "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", + "parameters": [ + { + "name": "FleetSid", + "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "schema": { + "type": "string" }, "required": true } @@ -4414,7 +3634,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "examples": { + "update": { + "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4426,54 +3664,40 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesDevice", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateHostedNumbersAuthorizationDocumentRequest", + "title": "UpdateDeployedDevicesDeviceRequest", "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { + "FriendlyName": { "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." }, - "Status": { + "Identity": { "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." }, - "ContactTitle": { + "DeploymentSid": { "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." + "Enabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Identity": "identity" } } } @@ -4482,38 +3706,133 @@ } } }, - "/HostedNumbers/AuthorizationDocuments": { + "/DeployedDevices/Fleets/{FleetSid}/Devices": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "dependent_hosted_number_order": "{signing_document_sid: sid}" + "parent": "/Fleets/{Sid}", + "pathType": "list" + }, + "post": { + "description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "examples": { + "create": { + "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesDevice", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesDeviceRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." + }, + "Identity": { + "type": "string", + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + }, + "DeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." + }, + "Enabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Identity": "identity" + } + } + } + } + } } }, "get": { - "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "description": "Retrieve a list of all Devices belonging to the Fleet.", "parameters": [ { - "name": "Email", - "in": "query", - "description": "Email that this AuthorizationDocument will be sent to for signing.", + "name": "FleetSid", + "in": "path", + "description": "", "schema": { "type": "string" - } + }, + "required": true }, { - "name": "Status", + "name": "DeploymentSid", "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", "schema": { "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status" + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" } }, { @@ -4550,25 +3869,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListHostedNumbersAuthorizationDocumentResponse", + "title": "ListDeployedDevicesDeviceResponse", "properties": { - "items": { + "devices": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4577,17 +3898,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "devices": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "devices": [ + { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" } } } @@ -4602,23 +3966,69 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesDevice" + } + }, + "/DeployedDevices/Fleets/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "device": "{fleet_sid: sid}", + "deployment": "{fleet_sid: sid}", + "certificate": "{fleet_sid: sid}", + "key": "{fleet_sid: sid}" + }, + "pathType": "instance" }, - "post": { - "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "get": { + "description": "Fetch information about a specific Fleet in your account.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "examples": { + "fetch": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -4626,136 +4036,201 @@ "accountSid_authToken": [] } ], - "operationId": "CreateHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" + "operationId": "FetchDeployedDevicesFleet" + }, + "delete": { + "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesFleet" + }, + "post": { + "description": "Update the friendly name property of a specific Fleet in your account.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "examples": { + "update": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "UpdateDeployedDevicesFleet", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateHostedNumbersAuthorizationDocumentRequest", + "title": "UpdateDeployedDevicesFleetRequest", "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." }, - "AddressSid": { + "DefaultDeploymentSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." - }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "DefaultDeploymentSid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "device": "{fleet_sid: sid}", + "deployment": "{fleet_sid: sid}", + "certificate": "{fleet_sid: sid}", + "key": "{fleet_sid: sid}" + }, + "pathType": "list" + }, + "post": { + "description": "Create a new Fleet for scoping of deployed devices within your account.", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" }, - "required": [ - "HostedNumberOrderSids", - "AddressSid", - "Email", - "ContactTitle", - "ContactPhoneNumber" - ] + "examples": { + "create": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesFleet", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesFleetRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } } - } - }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/AuthorizationDocuments/{Sid}" }, "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "description": "Retrieve a list of all Fleets belonging to your account.", "parameters": [ - { - "name": "SigningDocumentSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - } - }, { "name": "PageSize", "in": "query", @@ -4790,25 +4265,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListHostedNumbersDependentHostedNumberOrderResponse", + "title": "ListDeployedDevicesFleetResponse", "properties": { - "items": { + "fleets": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4817,17 +4294,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "fleets": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "fleets": [ + { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" } } } @@ -4842,35 +4364,42 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersDependentHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesFleet" } }, - "/HostedNumbers/HostedNumberOrders/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "Fetch a specific HostedNumberOrder.", + "description": "Fetch information about a specific Key credential in the Fleet.", "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -4880,7 +4409,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "fetch": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4892,23 +4436,29 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesKey" }, "delete": { - "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -4923,23 +4473,29 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesKey" }, "post": { - "description": "Updates a specific HostedNumberOrder.", + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", "parameters": [ { - "name": "Sid", + "name": "FleetSid", "in": "path", "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -4949,7 +4505,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "update": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4961,129 +4532,151 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateDeployedDevicesKey", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateHostedNumbersHostedNumberOrderRequest", + "title": "UpdateDeployedDevicesKeyRequest", "properties": { "FriendlyName": { "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, - "UniqueName": { - "type": "string", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "Email": { - "type": "string", - "description": "Email of the owner of this phone number that is being hosted." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status", - "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." }, - "VerificationCode": { + "DeviceSid": { "type": "string", - "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." - }, - "VerificationType": { + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Fleets/{Sid}", + "pathType": "list" + }, + "post": { + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "create": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesKey", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesKeyRequest", + "properties": { + "FriendlyName": { "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." }, - "VerificationDocumentSid": { + "DeviceSid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." - }, - "Extension": { - "type": "string", - "description": "Digits to dial after connecting the verification call." - }, - "CallDelay": { - "type": "integer", - "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + }, + "examples": { + "create": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } } } } - } - }, - "/HostedNumbers/HostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list" }, "get": { - "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", "parameters": [ { - "name": "Status", - "in": "query", - "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status" - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "name": "FleetSid", + "in": "path", + "description": "", "schema": { - "type": "string", - "format": "phone-number" - } + "type": "string" + }, + "required": true }, { - "name": "IncomingPhoneNumberSid", + "name": "DeviceSid", "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" + "pattern": "^TH[0-9a-fA-F]{32}$" } }, { @@ -5120,25 +4713,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListHostedNumbersHostedNumberOrderResponse", + "title": "ListDeployedDevicesKeyResponse", "properties": { - "items": { + "keys": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5146,191 +4741,73 @@ "page_size": { "type": "integer" }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Host a phone number's capability on Twilio's platform.", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateHostedNumbersHostedNumberOrderRequest", - "properties": { - "PhoneNumber": { - "type": "string", - "format": "phone-number", - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" - }, - "SmsCapability": { - "type": "boolean", - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." - }, - "AccountSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." - }, - "FriendlyName": { - "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, - "UniqueName": { - "type": "string", - "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." - }, - "SmsUrl": { - "type": "string", - "format": "uri", - "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackUrl": { - "type": "string", - "format": "uri", - "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "StatusCallbackUrl": { - "type": "string", - "format": "uri", - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." - }, - "StatusCallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." - }, - "SmsApplicationSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." - }, - "Email": { - "type": "string", - "description": "Optional. Email of the owner of this phone number that is being hosted." - }, - "VerificationType": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." - }, - "VerificationDocumentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } } }, - "required": [ - "PhoneNumber", - "SmsCapability" - ] + "examples": { + "readEmpty": { + "value": { + "keys": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "keys": [ + { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" + } + } + } + } } - } + }, + "description": "OK" } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesKey" } }, "/marketplace/AvailableAddOns/{Sid}": { @@ -5339,13 +4816,13 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "available_add_on_extension": "{available_add_on_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch an instance of an Add-on currently available to be installed.", @@ -5369,6 +4846,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.available_add_on" + }, + "examples": { + "fetch": { + "value": { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + } } } }, @@ -5380,10 +4882,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceAvailableAddOn" } }, "/marketplace/AvailableAddOns": { @@ -5392,13 +4891,13 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "available_add_on_extension": "{available_add_on_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of Add-ons currently available to be installed.", @@ -5446,16 +4945,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5464,17 +4965,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "available_add_ons": [ + { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" + } + } + }, + "readEmpty": { + "value": { + "available_add_ons": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" } } } @@ -5489,10 +5040,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceAvailableAddOn" } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { @@ -5501,12 +5049,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension" + "className": "available_add_on_extension", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Available Add-on.", @@ -5542,6 +5090,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5553,10 +5113,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceAvailableAddOnExtension" } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { @@ -5565,12 +5122,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension" + "className": "available_add_on_extension", + "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Available Add-on.", @@ -5630,16 +5187,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5648,17 +5207,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + }, + "readEmpty": { + "value": { + "extensions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -5673,10 +5269,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceAvailableAddOnExtension" } }, "/marketplace/InstalledAddOns": { @@ -5685,13 +5278,13 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "installed_add_on_extension": "{installed_add_on_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Install an Add-on for the Account specified.", @@ -5701,6 +5294,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "examples": { + "create": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_1", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5713,9 +5327,6 @@ } ], "operationId": "CreateMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5746,6 +5357,16 @@ "AvailableAddOnSid", "AcceptTermsOfService" ] + }, + "examples": { + "create": { + "value": { + "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AcceptTermsOfService": true, + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_1" + } + } } } } @@ -5797,16 +5418,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5815,17 +5438,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "installed_add_ons": [ + { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" + } + } + }, + "readEmpty": { + "value": { + "installed_add_ons": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" } } } @@ -5840,10 +5509,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceInstalledAddOn" } }, "/marketplace/InstalledAddOns/{Sid}": { @@ -5852,13 +5518,13 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "installed_add_on_extension": "{installed_add_on_sid: sid}" - } + }, + "pathType": "instance" }, "delete": { "description": "Remove an Add-on installation from your account", @@ -5886,10 +5552,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteMarketplaceInstalledAddOn" }, "get": { "description": "Fetch an instance of an Add-on currently installed on this Account.", @@ -5913,6 +5576,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "examples": { + "fetch": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5924,10 +5608,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceInstalledAddOn" }, "post": { "description": "Update an Add-on installation for the Account specified.", @@ -5951,6 +5632,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "examples": { + "update": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_2", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -5963,9 +5665,6 @@ } ], "operationId": "UpdateMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5981,6 +5680,14 @@ "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } } + }, + "examples": { + "update": { + "value": { + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_2" + } + } } } } @@ -5993,12 +5700,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension" + "className": "installed_add_on_extension", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an Extension for the Installed Add-on.", @@ -6034,6 +5741,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6045,10 +5765,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceInstalledAddOnExtension" }, "post": { "description": "Update an Extension for an Add-on installation.", @@ -6084,6 +5801,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "examples": { + "update": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": false, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6096,9 +5826,6 @@ } ], "operationId": "UpdateMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6114,6 +5841,13 @@ "required": [ "Enabled" ] + }, + "examples": { + "update": { + "value": { + "Enabled": false + } + } } } } @@ -6126,12 +5860,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension" + "className": "installed_add_on_extension", + "pathType": "list" }, "get": { "description": "Retrieve a list of Extensions for the Installed Add-on.", @@ -6191,16 +5925,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6209,17 +5945,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + }, + "readEmpty": { + "value": { + "extensions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -6234,10 +6008,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceInstalledAddOnExtension" } }, "/Sync/Services/{ServiceSid}/Documents/{Sid}": { @@ -6246,14 +6017,14 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "document_permission": "{service_sid: service_sid, document_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -6286,6 +6057,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -6297,10 +6087,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncDocument" }, "delete": { "description": "", @@ -6337,10 +6124,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncDocument" }, "post": { "description": "", @@ -6381,6 +6165,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -6393,9 +6196,6 @@ } ], "operationId": "UpdateSyncDocument", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6410,6 +6210,14 @@ "required": [ "Data" ] + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" + } + } } } } @@ -6422,14 +6230,14 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "document_permission": "{service_sid: service_sid, document_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -6453,6 +6261,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -6465,9 +6292,6 @@ } ], "operationId": "CreateSyncDocument", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6483,6 +6307,14 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" + } + } } } } @@ -6546,16 +6378,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6564,17 +6398,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "documents": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "documents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } } @@ -6589,10 +6467,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncDocument" } }, "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { @@ -6601,12 +6476,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" + "mountName": "document_permissions", + "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Document Permission.", @@ -6648,6 +6523,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -6659,10 +6548,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", @@ -6708,10 +6594,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", @@ -6753,6 +6636,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -6765,9 +6662,6 @@ } ], "operationId": "UpdateSyncDocumentPermission", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6793,6 +6687,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -6805,12 +6708,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" + "mountName": "document_permissions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Document.", @@ -6879,16 +6782,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6897,17 +6802,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -6922,10 +6866,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncDocumentPermission" } }, "/Sync/Services/{Sid}": { @@ -6934,15 +6875,15 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "document": "{service_sid: sid}", "sync_list": "{service_sid: sid}", "sync_map": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -6966,6 +6907,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false + } + } } } }, @@ -6977,10 +6938,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncService" }, "delete": { "description": "", @@ -7008,10 +6966,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncService" }, "post": { "description": "", @@ -7035,6 +6990,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } } } }, @@ -7047,9 +7022,6 @@ } ], "operationId": "UpdateSyncService", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7075,6 +7047,15 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } } } } @@ -7087,15 +7068,15 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "document": "{service_sid: sid}", "sync_list": "{service_sid: sid}", "sync_map": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -7105,6 +7086,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } } } }, @@ -7117,9 +7118,6 @@ } ], "operationId": "CreateSyncService", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7145,6 +7143,15 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } } } } @@ -7196,16 +7203,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7214,18 +7223,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false + } + ] } } } @@ -7239,10 +7293,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncService" } }, "/Sync/Services/{ServiceSid}/Lists/{Sid}": { @@ -7251,16 +7302,16 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "sync_list_item": "{service_sid: service_sid, list_sid: sid}", "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "instance" }, "get": { "description": "", @@ -7293,6 +7344,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7304,10 +7374,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncList" }, "delete": { "description": "", @@ -7344,10 +7411,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncList" } }, "/Sync/Services/{ServiceSid}/Lists": { @@ -7356,16 +7420,16 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "sync_list_item": "{service_sid: service_sid, list_sid: sid}", "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "list" }, "post": { "description": "", @@ -7389,6 +7453,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7401,9 +7484,6 @@ } ], "operationId": "CreateSyncSyncList", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7416,6 +7496,13 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } } } } @@ -7479,16 +7566,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7497,17 +7586,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "lists": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } } @@ -7522,10 +7655,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncList" } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { @@ -7534,12 +7664,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "instance" }, "get": { "description": "", @@ -7581,6 +7711,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -7592,10 +7738,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncListItem" }, "delete": { "description": "", @@ -7649,10 +7792,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncListItem" }, "post": { "description": "", @@ -7702,6 +7842,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -7714,9 +7870,6 @@ } ], "operationId": "UpdateSyncSyncListItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7731,6 +7884,13 @@ "required": [ "Data" ] + }, + "examples": { + "update": { + "value": { + "Data": "{}" + } + } } } } @@ -7743,12 +7903,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "list" }, "post": { "description": "", @@ -7781,6 +7941,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -7793,9 +7969,6 @@ } ], "operationId": "CreateSyncSyncListItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7810,6 +7983,13 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } } } } @@ -7846,6 +8026,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -7854,6 +8042,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -7863,6 +8059,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -7908,16 +8112,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7926,17 +8132,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -7951,10 +8198,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncListItem" } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { @@ -7963,12 +8207,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions" + "mountName": "sync_list_permissions", + "pathType": "instance" }, "get": { "description": "Fetch a specific Sync List Permission.", @@ -8010,6 +8254,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -8021,10 +8279,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", @@ -8070,10 +8325,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", @@ -8115,6 +8367,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -8127,9 +8393,6 @@ } ], "operationId": "UpdateSyncSyncListPermission", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8155,6 +8418,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -8167,12 +8439,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions" + "mountName": "sync_list_permissions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync List.", @@ -8241,16 +8513,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8259,17 +8533,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -8284,10 +8597,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncListPermission" } }, "/Sync/Services/{ServiceSid}/Maps/{Sid}": { @@ -8296,16 +8606,16 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "sync_map_item": "{service_sid: service_sid, map_sid: sid}", "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "instance" }, "get": { "description": "", @@ -8338,6 +8648,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8349,10 +8678,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMap" }, "delete": { "description": "", @@ -8389,10 +8715,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMap" } }, "/Sync/Services/{ServiceSid}/Maps": { @@ -8401,16 +8724,16 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "sync_map_item": "{service_sid: service_sid, map_sid: sid}", "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "list" }, "post": { "description": "", @@ -8434,6 +8757,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8446,9 +8788,6 @@ } ], "operationId": "CreateSyncSyncMap", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8461,6 +8800,13 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } } } } @@ -8524,16 +8870,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8542,17 +8890,61 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "maps": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "maps": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } @@ -8567,10 +8959,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMap" } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { @@ -8579,12 +8968,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "instance" }, "get": { "description": "", @@ -8626,6 +9015,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -8637,10 +9042,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMapItem" }, "delete": { "description": "", @@ -8694,10 +9096,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMapItem" }, "post": { "description": "", @@ -8747,6 +9146,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -8759,9 +9174,6 @@ } ], "operationId": "UpdateSyncSyncMapItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8776,6 +9188,13 @@ "required": [ "Data" ] + }, + "examples": { + "update": { + "value": { + "Data": "{}" + } + } } } } @@ -8788,12 +9207,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "list" }, "post": { "description": "", @@ -8826,6 +9245,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -8838,9 +9273,6 @@ } ], "operationId": "CreateSyncSyncMapItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8860,6 +9292,14 @@ "Key", "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key" + } + } } } } @@ -8896,6 +9336,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -8904,6 +9352,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -8913,6 +9369,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -8958,16 +9422,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8976,17 +9442,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -9001,10 +9508,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMapItem" } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { @@ -9013,12 +9517,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "mountName": "sync_map_permissions", + "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Map Permission.", @@ -9060,6 +9564,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -9071,10 +9589,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", @@ -9120,10 +9635,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", @@ -9165,6 +9677,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -9177,9 +9703,6 @@ } ], "operationId": "UpdateSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9205,6 +9728,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -9217,12 +9749,12 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "mountName": "sync_map_permissions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Map.", @@ -9291,16 +9823,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9309,17 +9843,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -9334,10 +9907,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMapPermission" } }, "/understand/Assistants/{Sid}": { @@ -9346,10 +9916,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "field_type": "{assistant_sid: sid}", "task": "{assistant_sid: sid}", @@ -9359,7 +9928,8 @@ "assistant_initiation_actions": "{assistant_sid: sid}", "dialogue": "{assistant_sid: sid}", "style_sheet": "{assistant_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -9380,6 +9950,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.understand.assistant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", + "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", + "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } } } }, @@ -9391,10 +9988,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchUnderstandAssistant" }, "post": { "description": "", @@ -9415,6 +10009,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.understand.assistant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", + "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", + "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } } } }, @@ -9427,9 +10048,6 @@ } ], "operationId": "UpdateUnderstandAssistant", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9468,6 +10086,20 @@ "description": "The JSON object that holds the style sheet for the assistant" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "so so friendly", + "UniqueName": "so-so-unique", + "LogQueries": true, + "CallbackUrl": "https://example.com/callback_url", + "CallbackEvents": "model_build_completed model_build_failed", + "FallbackActions": "{\"actions\":[{}]}", + "InitiationActions": "{\"actions\":[{}]}", + "StyleSheet": "{}" + } + } } } } @@ -9496,10 +10128,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandAssistant" } }, "/understand/Assistants": { @@ -9508,10 +10137,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "field_type": "{assistant_sid: sid}", "task": "{assistant_sid: sid}", @@ -9521,7 +10149,8 @@ "assistant_initiation_actions": "{assistant_sid: sid}", "dialogue": "{assistant_sid: sid}", "style_sheet": "{assistant_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "", @@ -9569,16 +10198,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9587,17 +10218,69 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "assistants": [], + "meta": { + "first_page_url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0", + "key": "assistants", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "assistants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", + "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", + "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0", + "key": "assistants", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0" } } } @@ -9612,10 +10295,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandAssistant", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandAssistant" }, "post": { "description": "", @@ -9625,10 +10305,313 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.understand.assistant" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-04T08:34:00Z", + "date_updated": "2017-07-04T08:34:00Z", + "friendly_name": "so so friendly", + "latest_model_build_sid": null, + "log_queries": true, + "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "so-so-unique", + "links": { + "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", + "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", + "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", + "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", + "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", + "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", + "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "callback_url": "https://example.com/callback_url", + "callback_events": "model_build_completed model_build_failed" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUnderstandAssistant", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandAssistantRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." + }, + "LogQueries": { + "type": "boolean", + "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." + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "A user-provided URL to send event callbacks to." + }, + "CallbackEvents": { + "type": "string", + "description": "Space-separated list of callback events that will trigger callbacks." + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant" + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "so so friendly", + "UniqueName": "so-so-unique", + "LogQueries": true, + "CallbackUrl": "https://example.com/callback_url", + "CallbackEvents": "model_build_completed model_build_failed", + "FallbackActions": "{\"actions\":[{}]}", + "InitiationActions": "{\"actions\":[{}]}", + "StyleSheet": "{}" + } + } + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/FallbackActions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{Sid}", + "mountName": "assistant_fallback_actions", + "className": "assistant_fallback_actions", + "pathType": "instance" + }, + "get": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", + "data": {} + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandAssistantFallbackActions" + }, + "post": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", + "data": {} + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateUnderstandAssistantFallbackActions", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUnderstandAssistantFallbackActionsRequest", + "properties": { + "FallbackActions": { + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "FallbackActions": "{\"actions\":[{}]}" + } + } + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/InitiationActions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{Sid}", + "mountName": "assistant_initiation_actions", + "className": "assistant_initiation_actions", + "pathType": "instance" + }, + "get": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {}, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandAssistantInitiationActions" + }, + "post": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", + "data": {} + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -9636,46 +10619,23 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandAssistant", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateUnderstandAssistantInitiationActions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandAssistantRequest", + "title": "UpdateUnderstandAssistantInitiationActionsRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." - }, - "LogQueries": { - "type": "boolean", - "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." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "A user-provided URL to send event callbacks to." - }, - "CallbackEvents": { - "type": "string", - "description": "Space-separated list of callback events that will trigger callbacks." - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." - }, "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant" + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "InitiationActions": "{\"actions\":[{}]}" } } } @@ -9684,19 +10644,17 @@ } } }, - "/understand/Assistants/{AssistantSid}/FallbackActions": { + "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "parent": "/Assistants/{Sid}", - "mountName": "assistant_fallback_actions", - "className": "assistant_fallback_actions" + "pathType": "instance" }, "get": { "description": "", @@ -9709,6 +10667,15 @@ "type": "string" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true } ], "responses": { @@ -9716,7 +10683,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + "$ref": "#/components/schemas/preview.understand.assistant.dialogue" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk", + "data": {} + } + } } } }, @@ -9728,18 +10706,59 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistantFallbackActions", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchUnderstandDialogue" + } + }, + "/understand/Assistants/{AssistantSid}/Dialogues": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{Sid}", + "pathType": "list" + } + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "instance" }, - "post": { + "get": { "description": "", "parameters": [ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Field.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -9751,7 +10770,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + }, + "examples": { + "fetch": { + "value": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type": "field_type" + } + } } } }, @@ -9763,40 +10797,63 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistantFallbackActions", - "x-maturity": [ - "Preview" + "operationId": "FetchUnderstandField" + }, + "delete": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Field.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", + "schema": { + "type": "string" + }, + "required": true + } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandAssistantFallbackActionsRequest", - "properties": { - "FallbackActions": { - "description": "" - } - } - } - } + "responses": { + "204": { + "description": "The resource was deleted successfully." } - } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteUnderstandField" } }, - "/understand/Assistants/{AssistantSid}/InitiationActions": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}", - "mountName": "assistant_initiation_actions", - "className": "assistant_initiation_actions" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -9804,11 +10861,47 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } } ], "responses": { @@ -9816,7 +10909,90 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + "type": "object", + "title": "ListUnderstandFieldResponse", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "fields": [], + "meta": { + "page": 0, + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "key": "fields", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + } + } + }, + "readFull": { + "value": { + "fields": [ + { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type": "field_type" + } + ], + "meta": { + "page": 0, + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", + "key": "fields", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + } + } + } } } }, @@ -9828,10 +11004,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistantInitiationActions", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandField" }, "post": { "description": "", @@ -9839,7 +11012,16 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, @@ -9847,15 +11029,30 @@ } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + }, + "examples": { + "create": { + "value": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type": "field_type" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -9863,19 +11060,33 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistantInitiationActions", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateUnderstandField", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandAssistantInitiationActionsRequest", + "title": "CreateUnderstandFieldRequest", "properties": { - "InitiationActions": { - "description": "" + "FieldType": { + "type": "string", + "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." + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + } + }, + "required": [ + "FieldType", + "UniqueName" + ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "FieldType": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9884,17 +11095,20 @@ } } }, - "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { + "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "dependentProperties": { + "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" + }, + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -9923,7 +11137,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.dialogue" + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + }, + "examples": { + "fetch": { + "value": { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -9935,53 +11166,15 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandDialogue", - "x-maturity": [ - "Preview" - ] - } - }, - "/understand/Assistants/{AssistantSid}/Dialogues": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{Sid}" - } - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "operationId": "FetchUnderstandFieldType" }, - "get": { + "post": { "description": "", "parameters": [ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -9990,7 +11183,7 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, @@ -10002,7 +11195,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + }, + "examples": { + "update": { + "value": { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -10014,10 +11224,35 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandField", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdateUnderstandFieldType", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUnderstandFieldTypeRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" + } + } + } + } + } + } }, "delete": { "description": "", @@ -10025,16 +11260,7 @@ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -10043,7 +11269,7 @@ { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, @@ -10060,23 +11286,23 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandField", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandFieldType" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { + "/understand/Assistants/{AssistantSid}/FieldTypes": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "dependentProperties": { + "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" + }, + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -10084,16 +11310,7 @@ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -10133,25 +11350,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldResponse", + "title": "ListUnderstandFieldTypeResponse", "properties": { - "fields": { + "field_types": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.understand.assistant.field_type" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10160,18 +11379,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "previous_page_url": null, + "page": 0, + "page_size": 50, + "next_page_url": null, + "key": "field_types" + }, + "field_types": [] + } + }, + "readFull": { + "value": { + "meta": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", + "previous_page_url": null, + "page": 0, + "page_size": 50, + "next_page_url": null, + "key": "field_types" + }, + "field_types": [ + { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -10185,10 +11446,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandField", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandFieldType" }, "post": { "description": "", @@ -10196,16 +11454,7 @@ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the parent Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -10217,7 +11466,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + }, + "examples": { + "create": { + "value": { + "unique_name": "unique_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + }, + "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -10229,96 +11495,53 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandField", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateUnderstandFieldType", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandFieldRequest", + "title": "CreateUnderstandFieldTypeRequest", "properties": { - "FieldType": { - "type": "string", - "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." - }, "UniqueName": { "type": "string", "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." } }, "required": [ - "FieldType", "UniqueName" ] - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" - }, - "parent": "/Assistants/{Sid}" - }, - "get": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" + } } } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] + } } - ], - "operationId": "FetchUnderstandFieldType", - "x-maturity": [ - "Preview" - ] + } + } + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", + "pathType": "instance" }, - "post": { + "get": { "description": "", "parameters": [ { @@ -10330,6 +11553,15 @@ }, "required": true }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", @@ -10345,7 +11577,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "language": "language", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": "value", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "synonym_of": null + } + } } } }, @@ -10357,30 +11605,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandFieldType", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandFieldTypeRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - } - } - } - } - } - } + "operationId": "FetchUnderstandFieldValue" }, "delete": { "description": "", @@ -10394,6 +11619,15 @@ }, "required": true }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", @@ -10414,26 +11648,20 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandFieldType", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandFieldValue" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes": { + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "field_value": "{assistant_sid: assistant_sid, field_type_sid: sid}" - }, - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -10447,6 +11675,31 @@ }, "required": true }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Language", + "in": "query", + "description": "An ISO language-country string of the value. For example: *en-US*", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "language" + }, + "readFull": { + "value": "language" + } + } + }, { "name": "PageSize", "in": "query", @@ -10481,25 +11734,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldTypeResponse", + "title": "ListUnderstandFieldValueResponse", "properties": { - "field_types": { + "field_values": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10508,17 +11763,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "field_values": [], + "meta": { + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", + "page_size": 50, + "previous_page_url": null, + "key": "field_values", + "page": 0, + "next_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "field_values": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "language": "language", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": "value", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", + "page_size": 50, + "previous_page_url": null, + "key": "field_values", + "page": 0, + "next_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" } } } @@ -10533,10 +11829,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandFieldType", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandFieldValue" }, "post": { "description": "", @@ -10549,6 +11842,15 @@ "type": "string" }, "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true } ], "responses": { @@ -10556,7 +11858,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "language": "language", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": "value", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } }, @@ -10568,46 +11886,57 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandFieldType", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateUnderstandFieldValue", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandFieldTypeRequest", + "title": "CreateUnderstandFieldValueRequest", "properties": { - "UniqueName": { + "Language": { + "type": "string", + "description": "An ISO language-country string of the value." + }, + "Value": { "type": "string", "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." }, - "FriendlyName": { + "SynonymOf": { "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." } }, "required": [ - "UniqueName" + "Language", + "Value" ] + }, + "examples": { + "create": { + "value": { + "Value": "value", + "Language": "language", + "SynonymOf": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } } } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -10622,7 +11951,55 @@ "required": true }, { - "name": "FieldTypeSid", + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "enqueued", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": null, + "error_code": null + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandModelBuild" + }, + "post": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", "in": "path", "description": "", "schema": { @@ -10645,7 +12022,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": 100, + "error_code": null + } + } } } }, @@ -10657,10 +12050,30 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdateUnderstandModelBuild", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUnderstandModelBuildRequest", + "properties": { + "UniqueName": { + "type": "string", + "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" + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name" + } + } + } + } + } + } }, "delete": { "description": "", @@ -10674,15 +12087,6 @@ }, "required": true }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", @@ -10703,52 +12107,32 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandModelBuild" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { + "/understand/Assistants/{AssistantSid}/ModelBuilds": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the value. For example: *en-US*", + "name": "AssistantSid", + "in": "path", + "description": "", "schema": { "type": "string" - } + }, + "required": true }, { "name": "PageSize", @@ -10784,25 +12168,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldValueResponse", + "title": "ListUnderstandModelBuildResponse", "properties": { - "field_values": { + "model_builds": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10811,18 +12197,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "page": 0, + "key": "model_builds", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + }, + "model_builds": [] + } + }, + "readFull": { + "value": { + "meta": { + "page": 0, + "key": "model_builds", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "next_page_url": null, + "previous_page_url": null, + "page_size": 50 + }, + "model_builds": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "failed", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": null, + "error_code": 23001 + } + ] } } } @@ -10836,10 +12263,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandFieldValue", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandModelBuild" }, "post": { "description": "", @@ -10852,15 +12276,6 @@ "type": "string" }, "required": true - }, - { - "name": "FieldTypeSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true } ], "responses": { @@ -10868,7 +12283,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "enqueued", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "build_duration": null, + "error_code": null + } + } } } }, @@ -10880,51 +12311,49 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandFieldValue", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateUnderstandModelBuild", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandFieldValueRequest", + "title": "CreateUnderstandModelBuildRequest", "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the value." - }, - "Value": { + "StatusCallback": { "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "format": "uri", + "description": "" }, - "SynonymOf": { + "UniqueName": { "type": "string", - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." + "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" } - }, - "required": [ - "Language", - "Value" - ] + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "StatusCallback": "http://www.example.com" + } + } } } } } } }, - "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { + "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -10932,7 +12361,7 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { "type": "string" }, @@ -10941,7 +12370,7 @@ { "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -10953,7 +12382,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.understand.assistant.query" + }, + "examples": { + "fetch": { + "value": { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": { + "name": "name", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": 0.9 + }, + "entities": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": "voice" + } + } } } }, @@ -10965,10 +12426,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchUnderstandQuery" }, "post": { "description": "", @@ -10976,7 +12434,7 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, @@ -10985,7 +12443,7 @@ { "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -10997,7 +12455,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.understand.assistant.query" + }, + "examples": { + "update": { + "value": { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": { + "name": "name", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": 0.9 + }, + "entities": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": "sms" + } + } } } }, @@ -11009,20 +12499,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandModelBuild", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateUnderstandQuery", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandModelBuildRequest", + "title": "UpdateUnderstandQueryRequest", "properties": { - "UniqueName": { + "SampleSid": { "type": "string", - "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" + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "description": "An optional reference to the Sample created from this query." + }, + "Status": { + "type": "string", + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" + } + } + }, + "examples": { + "update": { + "value": { + "Status": "status", + "SampleSid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -11036,7 +12538,7 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { "type": "string" }, @@ -11045,7 +12547,7 @@ { "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -11062,23 +12564,20 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandQuery" } }, - "/understand/Assistants/{AssistantSid}/ModelBuilds": { + "/understand/Assistants/{AssistantSid}/Queries": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -11086,12 +12585,60 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, "required": true }, + { + "name": "Language", + "in": "query", + "description": "An ISO language-country string of the sample.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "language" + }, + "readFull": { + "value": "language" + } + } + }, + { + "name": "ModelBuild", + "in": "query", + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + { + "name": "Status", + "in": "query", + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } + } + }, { "name": "PageSize", "in": "query", @@ -11126,25 +12673,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandModelBuildResponse", + "title": "ListUnderstandQueryResponse", "properties": { - "model_builds": { + "queries": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.understand.assistant.query" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11153,17 +12702,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "queries": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page": 0, + "key": "queries", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page_size": 50 + } + } + }, + "readFull": { + "value": { + "queries": [ + { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": { + "name": "name", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": 0.9 + }, + "entities": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": null + } + ], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page": 0, + "key": "queries", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", + "page_size": 50 } } } @@ -11178,10 +12784,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandModelBuild", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandQuery" }, "post": { "description": "", @@ -11189,7 +12792,7 @@ { "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, @@ -11201,7 +12804,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.understand.assistant.query" + }, + "examples": { + "create": { + "value": { + "language": "language", + "date_created": "2015-07-30T20:00:00Z", + "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "query": "query", + "date_updated": "2015-07-30T20:00:00Z", + "status": "status", + "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": { + "task": { + "name": "name", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "confidence": 0.9 + }, + "entities": [ + { + "name": "name", + "value": "value", + "type": "type" + } + ] + }, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_channel": "voice" + } + } } } }, @@ -11213,25 +12848,48 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandModelBuild", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateUnderstandQuery", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandModelBuildRequest", + "title": "CreateUnderstandQueryRequest", "properties": { - "StatusCallback": { + "Language": { "type": "string", - "format": "uri", - "description": "" + "description": "An ISO language-country string of the sample." }, - "UniqueName": { + "Query": { "type": "string", - "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" + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long." + }, + "Tasks": { + "type": "string", + "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*" + }, + "ModelBuild": { + "type": "string", + "description": "The Model Build Sid or unique name of the Model Build to be queried." + }, + "Field": { + "type": "string", + "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*" + } + }, + "required": [ + "Language", + "Query" + ] + }, + "examples": { + "create": { + "value": { + "Language": "language", + "Query": "query", + "Tasks": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "Field": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ModelBuild": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -11240,17 +12898,17 @@ } } }, - "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -11264,12 +12922,24 @@ }, "required": true }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Sample.", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" }, "required": true } @@ -11279,7 +12949,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + }, + "examples": { + "fetch": { + "value": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": null + } + } } } }, @@ -11291,18 +12977,24 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchUnderstandSample" }, "post": { "description": "", "parameters": [ { - "name": "AssistantSid", + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "The unique ID of the Task associated with this Sample.", "schema": { "type": "string" }, @@ -11313,7 +13005,10 @@ "in": "path", "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" }, "required": true } @@ -11323,7 +13018,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + }, + "examples": { + "update": { + "value": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": "alexa" + } + } } } }, @@ -11335,27 +13046,33 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandQuery", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateUnderstandSample", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandQueryRequest", + "title": "UpdateUnderstandSampleRequest", "properties": { - "SampleSid": { + "Language": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "description": "An optional reference to the Sample created from this query." + "description": "An ISO language-country string of the sample." }, - "Status": { + "TaggedText": { "type": "string", - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." + }, + "SourceChannel": { + "type": "string", + "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" + } + } + }, + "examples": { + "update": { + "value": { + "Language": "language", + "TaggedText": "tagged_text" } } } @@ -11375,12 +13092,24 @@ }, "required": true }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Sample.", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" }, "required": true } @@ -11395,23 +13124,20 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandSample" } }, - "/understand/Assistants/{AssistantSid}/Queries": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -11419,34 +13145,35 @@ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "The unique ID of the Assistant.", "schema": { "type": "string" }, "required": true }, { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the sample.", - "schema": { - "type": "string" - } - }, - { - "name": "ModelBuild", - "in": "query", - "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Sample.", "schema": { "type": "string" - } + }, + "required": true }, { - "name": "Status", + "name": "Language", "in": "query", - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "description": "An ISO language-country string of the sample.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "language" + }, + "readFull": { + "value": "language" + } } }, { @@ -11483,25 +13210,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandQueryResponse", + "title": "ListUnderstandSampleResponse", "properties": { - "queries": { + "samples": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11510,17 +13239,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "samples": [], + "meta": { + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "previous_page_url": null, + "key": "samples", + "next_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "page": 0, + "page_size": 50 + } + } + }, + "readFull": { + "value": { + "samples": [ + { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": "sms" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "previous_page_url": null, + "key": "samples", + "next_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", + "page": 0, + "page_size": 50 } } } @@ -11535,10 +13305,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandQuery", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandSample" }, "post": { "description": "", @@ -11546,7 +13313,16 @@ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Sample.", "schema": { "type": "string" }, @@ -11558,7 +13334,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + }, + "examples": { + "create": { + "value": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "language": "language", + "tagged_text": "tagged_text", + "date_updated": "2015-07-30T20:00:00Z", + "source_channel": "alexa" + } + } } } }, @@ -11570,59 +13362,182 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandQuery", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateUnderstandSample", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandQueryRequest", + "title": "CreateUnderstandSampleRequest", "properties": { "Language": { "type": "string", "description": "An ISO language-country string of the sample." }, - "Query": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long." - }, - "Tasks": { - "type": "string", - "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*" - }, - "ModelBuild": { + "TaggedText": { "type": "string", - "description": "The Model Build Sid or unique name of the Model Build to be queried." + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." }, - "Field": { + "SourceChannel": { "type": "string", - "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*" + "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" } }, "required": [ "Language", - "Query" + "TaggedText" ] + }, + "examples": { + "create": { + "value": { + "Language": "language", + "TaggedText": "tagged_text", + "SourceChannel": "alexa" + } + } } } } } } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { + "/understand/Assistants/{AssistantSid}/StyleSheet": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{Sid}", + "pathType": "instance" + }, + "get": { + "description": "Returns Style sheet JSON object for this Assistant", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {}, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandStyleSheet" + }, + "post": { + "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", + "data": {} + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateUnderstandStyleSheet", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUnderstandStyleSheetRequest", + "properties": { + "StyleSheet": { + "description": "The JSON Style sheet string" + } + } + }, + "examples": { + "update": { + "value": { + "StyleSheet": "{}" + } + } + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "dependentProperties": { + "field": "{assistant_sid: assistant_sid, task_sid: sid}", + "sample": "{assistant_sid: assistant_sid, task_sid: sid}", + "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", + "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" + }, + "parent": "/Assistants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -11636,24 +13551,12 @@ }, "required": true }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Sample.", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -11663,7 +13566,28 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.understand.assistant.task" + }, + "examples": { + "fetch": { + "value": { + "unique_name": "unique_name", + "links": { + "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + } } } }, @@ -11675,10 +13599,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandSample", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchUnderstandTask" }, "post": { "description": "", @@ -11692,24 +13613,12 @@ }, "required": true }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Sample.", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -11719,7 +13628,28 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.understand.assistant.task" + }, + "examples": { + "update": { + "value": { + "unique_name": "unique_name", + "links": { + "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + } } } }, @@ -11731,28 +13661,39 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandSample", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateUnderstandTask", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandSampleRequest", + "title": "UpdateUnderstandTaskRequest", "properties": { - "Language": { + "FriendlyName": { "type": "string", - "description": "An ISO language-country string of the sample." + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." }, - "TaggedText": { + "UniqueName": { "type": "string", - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." }, - "SourceChannel": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + }, + "ActionsUrl": { "type": "string", - "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" + "format": "uri", + "description": "User-provided HTTP endpoint where from the assistant fetches actions" + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Actions": "{\"say\":{\"speech\":\"Your order is ready for pickup\"}}", + "ActionsUrl": "https://example.com/actions_url" } } } @@ -11772,24 +13713,12 @@ }, "required": true }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Sample.", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -11804,23 +13733,26 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandSample", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteUnderstandTask" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { + "/understand/Assistants/{AssistantSid}/Tasks": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + "dependentProperties": { + "field": "{assistant_sid: assistant_sid, task_sid: sid}", + "sample": "{assistant_sid: assistant_sid, task_sid: sid}", + "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", + "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" + }, + "parent": "/Assistants/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -11834,23 +13766,6 @@ }, "required": true }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Sample.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the sample.", - "schema": { - "type": "string" - } - }, { "name": "PageSize", "in": "query", @@ -11885,25 +13800,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandSampleResponse", + "title": "ListUnderstandTaskResponse", "properties": { - "samples": { + "tasks": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.understand.assistant.task" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11912,18 +13829,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "key": "tasks", + "page_size": 50, + "next_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "previous_page_url": null + }, + "tasks": [] + } + }, + "readFull": { + "value": { + "meta": { + "key": "tasks", + "page_size": 50, + "next_page_url": null, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", + "previous_page_url": null + }, + "tasks": [ + { + "unique_name": "unique_name", + "links": { + "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + ] } } } @@ -11937,18 +13900,176 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandSample", - "x-maturity": [ - "Preview" - ] + "operationId": "ListUnderstandTask" + }, + "post": { + "description": "", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + }, + "examples": { + "create": { + "value": { + "unique_name": "unique_name", + "links": { + "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", + "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", + "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", + "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "actions_url": "https://example.com/actions_url" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUnderstandTask", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandTaskRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + }, + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + }, + "ActionsUrl": { + "type": "string", + "format": "uri", + "description": "User-provided HTTP endpoint where from the assistant fetches actions" + } + }, + "required": [ + "UniqueName" + ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Actions": "{\"say\":{\"speech\":\"Your order is ready for pickup\"}}", + "ActionsUrl": "https://example.com/actions_url" + } + } + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "mountName": "task_actions", + "className": "task_actions", + "pathType": "instance" + }, + "get": { + "description": "Returns JSON actions for this Task.", + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the parent Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDdddddddddddddddddddddddddddddddd", + "data": {}, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandTaskActions" }, "post": { - "description": "", + "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", "parameters": [ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, @@ -11957,7 +14078,7 @@ { "name": "TaskSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "The unique ID of the Task.", "schema": { "type": "string" }, @@ -11965,15 +14086,26 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDdddddddddddddddddddddddddddddddd", + "data": {}, + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -11981,59 +14113,60 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandSample", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateUnderstandTaskActions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandSampleRequest", + "title": "UpdateUnderstandTaskActionsRequest", "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the sample." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." - }, - "SourceChannel": { - "type": "string", - "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" + "Actions": { + "description": "The JSON actions that instruct the Assistant how to perform this task." } - }, - "required": [ - "Language", - "TaggedText" - ] + } + }, + "examples": { + "update": { + "value": { + "Actions": "{\"actions\":[{}]}" + } + } } } } } } }, - "/understand/Assistants/{AssistantSid}/StyleSheet": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{Sid}" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "className": "task_statistics", + "pathType": "instance" }, "get": { - "description": "Returns Style sheet JSON object for this Assistant", + "description": "", "parameters": [ { "name": "AssistantSid", "in": "path", - "description": "The unique ID of the Assistant", + "description": "The unique ID of the parent Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, @@ -12045,7 +14178,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" + }, + "examples": { + "fetch": { + "value": { + "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "samples_count": 0, + "fields_count": 0 + } + } } } }, @@ -12057,20 +14202,32 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandStyleSheet", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchUnderstandTaskStatistics" + } + }, + "/wireless/Commands/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance" }, - "post": { - "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", + "get": { + "description": "", "parameters": [ { - "name": "AssistantSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Assistant", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$" }, "required": true } @@ -12080,7 +14237,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + "$ref": "#/components/schemas/preview.wireless.command" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -12092,65 +14266,113 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandStyleSheet", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateUnderstandStyleSheetRequest", - "properties": { - "StyleSheet": { - "description": "The JSON Style sheet string" - } - } - } - } - } - } + "operationId": "FetchWirelessCommand" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { + "/wireless/Commands": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "field": "{assistant_sid: assistant_sid, task_sid: sid}", - "sample": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" - }, - "parent": "/Assistants/{Sid}" + "pathType": "list" }, "get": { "description": "", "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", + "name": "Device", + "in": "query", + "description": "", "schema": { "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "device" + }, + "readFull": { + "value": "device" + } + } }, { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "name": "Sim", + "in": "query", + "description": "", "schema": { "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "sim" + }, + "readFull": { + "value": "sim" + } + } + }, + { + "name": "Status", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } + } + }, + { + "name": "Direction", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "direction" + }, + "readFull": { + "value": "direction" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } } ], "responses": { @@ -12158,55 +14380,134 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "type": "object", + "title": "ListWirelessCommandResponse", + "properties": { + "commands": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.wireless.command" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "commands": [], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0" + } + } + } } } }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUnderstandTask", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, + "description": "OK" + } + }, + "security": [ { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", - "schema": { - "type": "string" - }, - "required": true + "accountSid_authToken": [] } ], + "operationId": "ListWirelessCommand" + }, + "post": { + "description": "", "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$ref": "#/components/schemas/preview.wireless.command" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -12214,107 +14515,80 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandTask", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateWirelessCommand", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandTaskRequest", + "title": "CreateWirelessCommandRequest", "properties": { - "FriendlyName": { + "Command": { "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + "description": "" }, - "UniqueName": { + "Device": { "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "description": "" }, - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + "Sim": { + "type": "string", + "description": "" }, - "ActionsUrl": { + "CallbackMethod": { + "type": "string", + "description": "" + }, + "CallbackUrl": { "type": "string", "format": "uri", - "description": "User-provided HTTP endpoint where from the assistant fetches actions" + "description": "" + }, + "CommandMode": { + "type": "string", + "description": "" + }, + "IncludeSid": { + "type": "string", + "description": "" + } + }, + "required": [ + "Command" + ] + }, + "examples": { + "create": { + "value": { + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "command_mode", + "Device": "device", + "Sim": "sim", + "IncludeSid": "include_sid" } } } } } } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteUnderstandTask", - "x-maturity": [ - "Preview" - ] } }, - "/understand/Assistants/{AssistantSid}/Tasks": { + "/wireless/RatePlans": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "field": "{assistant_sid: assistant_sid, task_sid: sid}", - "sample": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_actions": "{assistant_sid: assistant_sid, task_sid: sid}", - "task_statistics": "{assistant_sid: assistant_sid, task_sid: sid}" - }, - "parent": "/Assistants/{Sid}" + "pathType": "list" }, "get": { "description": "", "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "PageSize", "in": "query", @@ -12349,25 +14623,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandTaskResponse", + "title": "ListWirelessRatePlanResponse", "properties": { - "tasks": { + "rate_plans": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$ref": "#/components/schemas/preview.wireless.rate_plan" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -12376,18 +14652,67 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -12401,30 +14726,40 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandTask", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessRatePlan" }, "post": { "description": "", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - } - ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -12436,73 +14771,102 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandTask", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateWirelessRatePlan", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateUnderstandTaskRequest", + "title": "CreateWirelessRatePlanRequest", "properties": { "UniqueName": { "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "description": "" }, "FriendlyName": { "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + "description": "" }, - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + "DataEnabled": { + "type": "boolean", + "description": "" }, - "ActionsUrl": { + "DataLimit": { + "type": "integer", + "description": "" + }, + "DataMetering": { "type": "string", - "format": "uri", - "description": "User-provided HTTP endpoint where from the assistant fetches actions" + "description": "" + }, + "MessagingEnabled": { + "type": "boolean", + "description": "" + }, + "VoiceEnabled": { + "type": "boolean", + "description": "" + }, + "CommandsEnabled": { + "type": "boolean", + "description": "" + }, + "NationalRoamingEnabled": { + "type": "boolean", + "description": "" + }, + "InternationalRoaming": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" } - }, - "required": [ - "UniqueName" - ] + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "DataEnabled": true, + "DataLimit": 1000, + "DataMetering": "pooled", + "MessagingEnabled": true, + "VoiceEnabled": true, + "FriendlyName": "friendly_name", + "NationalRoamingEnabled": true, + "InternationalRoaming": [ + "data", + "voice", + "messaging" + ], + "Status": "status" + } + } } } } } } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "/wireless/RatePlans/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "mountName": "task_actions", - "className": "task_actions" + "pathType": "instance" }, "get": { - "description": "Returns JSON actions for this Task.", + "description": "", "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the parent Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Task.", + "description": "", "schema": { "type": "string" }, @@ -12514,7 +14878,31 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -12523,30 +14911,18 @@ }, "security": [ { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUnderstandTaskActions", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the parent Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", + "accountSid_authToken": [] + } + ], + "operationId": "FetchWirelessRatePlan" + }, + "post": { + "description": "", + "parameters": [ + { + "name": "Sid", "in": "path", - "description": "The unique ID of the Task.", + "description": "", "schema": { "type": "string" }, @@ -12558,7 +14934,31 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "pooled", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -12570,56 +14970,83 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandTaskActions", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateWirelessRatePlan", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandTaskActionsRequest", + "title": "UpdateWirelessRatePlanRequest", "properties": { - "Actions": { - "description": "The JSON actions that instruct the Assistant how to perform this task." + "UniqueName": { + "type": "string", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" } } } } } } + }, + "delete": { + "description": "", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteWirelessRatePlan" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { + "/wireless/Sims/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "className": "task_statistics" + "dependentProperties": { + "usage": "{sim_sid: sid}" + }, + "pathType": "instance" }, "get": { "description": "", "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the parent Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "", "schema": { "type": "string" }, @@ -12631,7 +15058,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" + "$ref": "#/components/schemas/preview.wireless.sim" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -12643,24 +15101,9 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandTaskStatistics", - "x-maturity": [ - "Preview" - ] - } - }, - "/wireless/Commands/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance" + "operationId": "FetchWirelessSim" }, - "get": { + "post": { "description": "", "parameters": [ { @@ -12668,10 +15111,7 @@ "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -12681,7 +15121,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.wireless.sim" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -12693,44 +15164,225 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessCommand", - "x-maturity": [ - "Preview" - ] + "operationId": "UpdateWirelessSim", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateWirelessSimRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + }, + "CallbackMethod": { + "type": "string", + "description": "" + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "FriendlyName": { + "type": "string", + "description": "" + }, + "RatePlan": { + "type": "string", + "description": "" + }, + "Status": { + "type": "string", + "description": "" + }, + "CommandsCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "CommandsCallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "VoiceFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "VoiceFallbackUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "VoiceMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "" + }, + "VoiceUrl": { + "type": "string", + "format": "uri", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "CommandsCallbackMethod": "http_method", + "CommandsCallbackUrl": "http://www.example.com", + "VoiceMethod": "http_method", + "VoiceUrl": "http://www.example.com", + "VoiceFallbackMethod": "http_method", + "VoiceFallbackUrl": "http://www.example.com", + "SmsMethod": "http_method", + "SmsUrl": "http://www.example.com", + "SmsFallbackMethod": "http_method", + "SmsFallbackUrl": "http://www.example.com", + "FriendlyName": "friendly_name", + "RatePlan": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Status": "status" + } + } + } + } + } + } } }, - "/wireless/Commands": { + "/wireless/Sims": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], + "dependentProperties": { + "usage": "{sim_sid: sid}" + }, "pathType": "list" }, "get": { "description": "", "parameters": [ { - "name": "Device", + "name": "Status", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } + } + }, + { + "name": "Iccid", "in": "query", "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } } }, { - "name": "Sim", + "name": "RatePlan", "in": "query", "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "rate_plan" + }, + "readFull": { + "value": "rate_plan" + } } }, { - "name": "Status", + "name": "EId", "in": "query", "description": "", "schema": { @@ -12738,7 +15390,7 @@ } }, { - "name": "Direction", + "name": "SimRegistrationCode", "in": "query", "description": "", "schema": { @@ -12779,25 +15431,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListWirelessCommandResponse", + "title": "ListWirelessSimResponse", "properties": { - "commands": { + "sims": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.wireless.sim" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -12806,17 +15460,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "sims": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" } } } @@ -12831,23 +15541,85 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessCommand", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessSim" + } + }, + "/wireless/Sims/{SimSid}/Usage": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Sims/{Sid}", + "pathType": "instance" }, - "post": { + "get": { "description": "", + "parameters": [ + { + "name": "SimSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "End", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "fetch": { + "value": "end" + } + } + }, + { + "name": "Start", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "fetch": { + "value": "start" + } + } + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.command" + "$ref": "#/components/schemas/preview.wireless.sim.usage" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands_costs": {}, + "commands_usage": {}, + "data_costs": {}, + "data_usage": {}, + "sim_unique_name": "sim_unique_name", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": {}, + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage" + } + } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -12855,70 +15627,247 @@ "accountSid_authToken": [] } ], - "operationId": "CreateWirelessCommand", - "x-maturity": [ - "Preview" + "operationId": "FetchWirelessUsage" + } + }, + "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "dependent_hosted_number_order": "{signing_document_sid: sid}" + }, + "pathType": "instance" + }, + "get": { + "description": "Fetch a specific AuthorizationDocument.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "examples": { + "fetch": { + "value": { + "address_sid": "AD11111111111111111111111111111111", + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchHostedNumbersAuthorizationDocument" + }, + "post": { + "description": "Updates a specific AuthorizationDocument.", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "examples": { + "update": { + "value": { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "UpdateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateWirelessCommandRequest", + "title": "UpdateHostedNumbersAuthorizationDocumentRequest", "properties": { - "Command": { - "type": "string", - "description": "" + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." }, - "Device": { + "AddressSid": { "type": "string", - "description": "" + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, - "Sim": { + "Email": { "type": "string", - "description": "" + "description": "Email that this AuthorizationDocument will be sent to for signing." }, - "CallbackMethod": { - "type": "string", - "description": "" + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" }, - "CallbackUrl": { + "Status": { "type": "string", - "format": "uri", - "description": "" + "$ref": "#/components/schemas/authorization_document_enum_status", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses." }, - "CommandMode": { + "ContactTitle": { "type": "string", - "description": "" + "description": "The title of the person authorized to sign the Authorization Document for this phone number." }, - "IncludeSid": { + "ContactPhoneNumber": { "type": "string", - "description": "" + "description": "The contact phone number of the person authorized to sign the Authorization Document." } - }, - "required": [ - "Command" - ] + } + }, + "examples": { + "update": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "Status": "signing", + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" + } + } } } } } } }, - "/wireless/RatePlans": { + "/HostedNumbers/AuthorizationDocuments": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], + "dependentProperties": { + "dependent_hosted_number_order": "{signing_document_sid: sid}" + }, "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", "parameters": [ + { + "name": "Email", + "in": "query", + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } + } + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status" + }, + "examples": { + "readEmpty": { + "value": "signed" + } + } + }, { "name": "PageSize", "in": "query", @@ -12953,25 +15902,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListWirelessRatePlanResponse", + "title": "ListHostedNumbersAuthorizationDocumentResponse", "properties": { - "rate_plans": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -12980,18 +15931,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" + }, + "items": [ + { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -13005,19 +16001,36 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessRatePlan", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersAuthorizationDocument" }, "post": { - "description": "", + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "examples": { + "create": { + "value": { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -13029,59 +16042,71 @@ "accountSid_authToken": [] } ], - "operationId": "CreateWirelessRatePlan", - "x-maturity": [ - "Preview" - ], + "operationId": "CreateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateWirelessRatePlanRequest", + "title": "CreateHostedNumbersAuthorizationDocumentRequest", "properties": { - "UniqueName": { - "type": "string", - "description": "" + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." }, - "FriendlyName": { + "AddressSid": { "type": "string", - "description": "" - }, - "DataEnabled": { - "type": "boolean", - "description": "" - }, - "DataLimit": { - "type": "integer", - "description": "" + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." }, - "DataMetering": { + "Email": { "type": "string", - "description": "" - }, - "MessagingEnabled": { - "type": "boolean", - "description": "" - }, - "VoiceEnabled": { - "type": "boolean", - "description": "" + "description": "Email that this AuthorizationDocument will be sent to for signing." }, - "CommandsEnabled": { - "type": "boolean", - "description": "" + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." }, - "NationalRoamingEnabled": { - "type": "boolean", - "description": "" + "ContactPhoneNumber": { + "type": "string", + "description": "The contact phone number of the person authorized to sign the Authorization Document." }, - "InternationalRoaming": { + "CcEmails": { "type": "array", "items": { "type": "string" }, - "description": "" + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + } + }, + "required": [ + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" } } } @@ -13090,63 +16115,129 @@ } } }, - "/wireless/RatePlans/{Sid}": { + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance" + "parent": "/AuthorizationDocuments/{Sid}", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", "parameters": [ { - "name": "Sid", + "name": "SigningDocumentSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" }, - "description": "OK" - } - }, - "security": [ + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWirelessRatePlan", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, { - "name": "Sid", - "in": "path", - "description": "", + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", "schema": { "type": "string" }, - "required": true + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "something123" + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } } ], "responses": { @@ -13154,59 +16245,116 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateWirelessRatePlan", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateWirelessRatePlanRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" + "type": "object", + "title": "ListHostedNumbersDependentHostedNumberOrderResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "items": [] + } }, - "FriendlyName": { - "type": "string", - "description": "" + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "failure_reason": "", + "unique_name": "foobar", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + ] + } } } } - } - } - } - }, - "delete": { - "description": "", - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "description": "OK" } }, "security": [ @@ -13214,35 +16362,32 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWirelessRatePlan", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersDependentHostedNumberOrder" } }, - "/wireless/Sims/{Sid}": { + "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "usage": "{sim_sid: sid}" - } + "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch a specific HostedNumberOrder.", "parameters": [ { "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -13252,7 +16397,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "5105", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + } } } }, @@ -13264,20 +16447,48 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessSim", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchHostedNumbersHostedNumberOrder" + }, + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteHostedNumbersHostedNumberOrder" }, "post": { - "description": "", + "description": "Updates a specific HostedNumberOrder.", "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -13287,7 +16498,45 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "new friendly name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "pending-loa", + "unique_name": "new unique name", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 1, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + } } } }, @@ -13299,131 +16548,77 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateWirelessSim", - "x-maturity": [ - "Preview" - ], + "operationId": "UpdateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateWirelessSimRequest", + "title": "UpdateHostedNumbersHostedNumberOrderRequest", "properties": { - "UniqueName": { - "type": "string", - "description": "" - }, - "CallbackMethod": { - "type": "string", - "description": "" - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "" - }, "FriendlyName": { "type": "string", - "description": "" - }, - "RatePlan": { - "type": "string", - "description": "" - }, - "Status": { - "type": "string", - "description": "" + "description": "A 64 character string that is a human readable text that describes this resource." }, - "CommandsCallbackMethod": { + "UniqueName": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" + "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." }, - "CommandsCallbackUrl": { + "Email": { "type": "string", - "format": "uri", - "description": "" + "description": "Email of the owner of this phone number that is being hosted." }, - "SmsFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." }, - "SmsFallbackUrl": { + "Status": { "type": "string", - "format": "uri", - "description": "" + "$ref": "#/components/schemas/hosted_number_order_enum_status", + "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." }, - "SmsMethod": { + "VerificationCode": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." }, - "SmsUrl": { + "VerificationType": { "type": "string", - "format": "uri", - "description": "" + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." }, - "VoiceFallbackMethod": { + "VerificationDocumentSid": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "" + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." }, - "VoiceFallbackUrl": { + "Extension": { "type": "string", - "format": "uri", - "description": "" + "description": "Digits to dial after connecting the verification call." }, - "VoiceMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" + "CallDelay": { + "type": "integer", + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." + } + } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "new friendly name", + "UniqueName": "new unique name", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" ], - "description": "" - }, - "VoiceUrl": { - "type": "string", - "format": "uri", - "description": "" + "Status": "pending-loa", + "Extension": "1234", + "CallDelay": 15 } } } @@ -13432,61 +16627,88 @@ } } }, - "/wireless/Sims": { + "/HostedNumbers/HostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "usage": "{sim_sid: sid}" - } + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", "parameters": [ { "name": "Status", "in": "query", - "description": "", + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", "schema": { - "type": "string" + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } } }, { - "name": "Iccid", + "name": "PhoneNumber", "in": "query", - "description": "", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "schema": { - "type": "string" + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } } }, { - "name": "RatePlan", + "name": "IncomingPhoneNumberSid", "in": "query", - "description": "", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } } }, { - "name": "EId", + "name": "FriendlyName", "in": "query", - "description": "", + "description": "A human readable description of this resource, up to 64 characters.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "example" + } } }, { - "name": "SimRegistrationCode", + "name": "UniqueName", "in": "query", - "description": "", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "something123" + } } }, { @@ -13523,25 +16745,27 @@ "application/json": { "schema": { "type": "object", - "title": "ListWirelessSimResponse", + "title": "ListHostedNumbersHostedNumberOrderResponse", "properties": { - "sims": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.wireless.sim" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -13550,18 +16774,81 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + ] } } } @@ -13575,63 +16862,112 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessSim", - "x-maturity": [ - "Preview" - ] - } - }, - "/wireless/Sims/{SimSid}/Usage": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Sims/{Sid}" + "operationId": "ListHostedNumbersHostedNumberOrder" }, - "get": { - "description": "", - "parameters": [ - { - "name": "SimSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "End", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "Start", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - } - ], + "post": { + "description": "Host a phone number's capability on Twilio's platform.", "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.wireless.sim.usage" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithPhoneBillVerification": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_type": "phone-bill" + } + } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -13639,10 +16975,162 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessUsage", - "x-maturity": [ - "Preview" - ] + "operationId": "CreateHostedNumbersHostedNumberOrder", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateHostedNumbersHostedNumberOrderRequest", + "properties": { + "PhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + }, + "SmsCapability": { + "type": "boolean", + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + }, + "AccountSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." + }, + "FriendlyName": { + "type": "string", + "description": "A 64 character string that is a human readable text that describes this resource." + }, + "UniqueName": { + "type": "string", + "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "StatusCallbackUrl": { + "type": "string", + "format": "uri", + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + }, + "StatusCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." + }, + "SmsApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "AD11111111111111111111111111111111", + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "Email": "test@twilio.com" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true + } + }, + "createWithPhoneBillVerification": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "VerificationType": "phone-bill", + "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } } } }, @@ -13650,11 +17138,5 @@ { "url": "https://preview.twilio.com" } - ], - "x-maturity": [ - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index 155658e3..cf635095 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "pricing.v1.messaging": { "type": "object", @@ -396,12 +402,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -417,7 +417,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -427,7 +427,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -449,8 +449,8 @@ "inbound_sms_prices", "price_unit" ], - "pathType": "list", - "parent": "/Messaging" + "parent": "/Messaging", + "pathType": "list" }, "get": { "description": "", @@ -498,16 +498,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -516,17 +518,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "countries": [ + { + "country": "country", + "iso_country": "US", + "url": "https://pricing.twilio.com/v1/Messaging/Countries/US" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0" } } } @@ -541,10 +577,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessagingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessagingCountry" } }, "/v1/Messaging/Countries/{IsoCountry}": { @@ -561,8 +594,8 @@ "inbound_sms_prices", "price_unit" ], - "pathType": "instance", - "parent": "/Messaging" + "parent": "/Messaging", + "pathType": "instance" }, "get": { "description": "", @@ -584,6 +617,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.messaging.messaging_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "country", + "inbound_sms_prices": [ + { + "base_price": "0.05", + "current_price": "0.05", + "number_type": "mobile" + } + ], + "iso_country": "US", + "outbound_sms_prices": [ + { + "carrier": "att", + "mcc": "foo", + "mnc": "bar", + "prices": [ + { + "base_price": "0.05", + "current_price": "0.05", + "number_type": "mobile" + } + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/Messaging/Countries/US" + } + } } } }, @@ -595,10 +659,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessagingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessagingCountry" } }, "/v1/PhoneNumbers": { @@ -607,7 +668,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -627,8 +688,8 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/PhoneNumbers" + "parent": "/PhoneNumbers", + "pathType": "list" }, "get": { "description": "", @@ -676,16 +737,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -694,17 +757,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Austria", + "iso_country": "AT", + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries/AT" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0", + "next_page_url": null, + "key": "countries" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0" } } } @@ -719,10 +816,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListPhoneNumberCountry" } }, "/v1/PhoneNumbers/Countries/{IsoCountry}": { @@ -737,8 +831,8 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/PhoneNumbers" + "parent": "/PhoneNumbers", + "pathType": "instance" }, "get": { "description": "", @@ -760,6 +854,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.phone_number.phone_number_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "iso_country": "US", + "phone_number_prices": [ + { + "number_type": "local", + "base_price": "1.00", + "current_price": "1.00" + }, + { + "number_type": "toll free", + "base_price": "2.00", + "current_price": "2.00" + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/PhoneNumbers/Countries/US" + } + } } } }, @@ -771,10 +887,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumberCountry" } }, "/v1/Voice": { @@ -783,7 +896,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -803,8 +916,8 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" }, "get": { "description": "", @@ -852,16 +965,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -870,17 +985,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Andorra", + "iso_country": "AD", + "url": "https://pricing.twilio.com/v1/Voice/Countries/AD" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0" } } } @@ -895,10 +1044,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListVoiceCountry" } }, "/v1/Voice/Countries/{IsoCountry}": { @@ -913,8 +1059,8 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "", @@ -936,6 +1082,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.voice.voice_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "inbound_call_prices": [ + { + "current_price": "0.0085", + "number_type": "local", + "base_price": "0.0085" + }, + { + "current_price": "0.022", + "number_type": "toll free", + "base_price": "0.022" + } + ], + "iso_country": "US", + "outbound_prefix_prices": [ + { + "prefixes": [ + "1907" + ], + "current_price": "0.090", + "friendly_name": "Programmable Outbound Minute - United States - Alaska", + "base_price": "0.090" + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/Voice/Countries/US" + } + } } } }, @@ -947,10 +1125,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceCountry" } }, "/v1/Voice/Numbers/{Number}": { @@ -967,8 +1142,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "", @@ -990,6 +1165,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v1.voice.voice_number" + }, + "examples": { + "fetch": { + "value": { + "country": "Iran", + "inbound_call_price": { + "base_price": null, + "current_price": null, + "number_type": null + }, + "iso_country": "IR", + "number": "+987654321", + "outbound_call_price": { + "base_price": "0.255", + "current_price": "0.255" + }, + "price_unit": "USD", + "url": "https://pricing.twilio.com/v1/Voice/Numbers/+987654321" + } + } } } }, @@ -1001,10 +1196,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceNumber" } }, "/v1/Voice/Numbers": { @@ -1021,8 +1213,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" } } }, @@ -1030,11 +1222,5 @@ { "url": "https://pricing.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index 36b2bb60..e1b2ca88 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "pricing.v2.trunking_country": { "type": "object", @@ -395,12 +401,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -416,7 +416,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -480,16 +480,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -498,17 +500,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Andorra", + "iso_country": "AD", + "url": "https://pricing.twilio.com/v2/Trunking/Countries/AD" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0" } } } @@ -523,10 +559,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrunkingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrunkingCountry" } }, "/v2/Trunking/Countries/{IsoCountry}": { @@ -563,6 +596,79 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.trunking_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "originating_call_prices": [ + { + "base_price": null, + "current_price": "0.0085", + "number_type": "local" + }, + { + "base_price": null, + "current_price": "0.022", + "number_type": "toll free" + } + ], + "iso_country": "US", + "terminating_prefix_prices": [ + { + "base_price": null, + "current_price": "0.090", + "destination_prefixes": [ + "1907" + ], + "friendly_name": "Outbound Trunking Minute - United States - Alaska", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1808" + ], + "friendly_name": "Outbound Trunking Minute - United States - Hawaii", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1800", + "1844", + "1855", + "1866", + "1877", + "1888" + ], + "friendly_name": "Outbound Trunking Minute - United States & Canada - Toll Free", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1" + ], + "friendly_name": "Outbound Trunking Minute - United States & Canada", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Trunking/Countries/US" + } + } } } }, @@ -574,10 +680,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunkingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunkingCountry" } }, "/v2/Trunking/Numbers/{DestinationNumber}": { @@ -615,6 +718,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "fetchWithOrigination": { + "value": "+15105556789" + } } } ], @@ -624,6 +732,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.trunking_number" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "destination_number": "+18001234567", + "originating_call_price": { + "base_price": null, + "current_price": null, + "number_type": null + }, + "iso_country": "US", + "origination_number": null, + "terminating_prefix_prices": [ + { + "base_price": null, + "current_price": "0.013", + "destination_prefixes": [ + "1800" + ], + "friendly_name": "Trunking Outbound Minute - United States Zone 1b", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567" + } + }, + "fetchWithOrigination": { + "value": { + "country": "United States", + "destination_number": "+18001234567", + "originating_call_price": { + "base_price": null, + "current_price": "0.013", + "number_type": "tollfree" + }, + "iso_country": "US", + "origination_number": "+15105556789", + "terminating_prefix_prices": [ + { + "base_price": null, + "current_price": "0.001", + "destination_prefixes": [ + "1800" + ], + "friendly_name": "Trunking Outbound Minute - United States - Toll Free", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567" + } + } } } }, @@ -635,10 +801,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunkingNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunkingNumber" } }, "/v2/Trunking/Numbers": { @@ -683,8 +846,8 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" }, "get": { "description": "", @@ -732,16 +895,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -750,17 +915,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "countries": [ + { + "country": "Andorra", + "iso_country": "AD", + "url": "https://pricing.twilio.com/v2/Voice/Countries/AD" + } + ], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "countries": [], + "meta": { + "first_page_url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0", + "key": "countries", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0" } } } @@ -775,10 +974,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListVoiceCountry" } }, "/v2/Voice/Countries/{IsoCountry}": { @@ -793,8 +989,8 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "Fetch a specific Country.", @@ -816,6 +1012,79 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.voice.voice_country-instance" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "inbound_call_prices": [ + { + "base_price": "0.0085", + "current_price": "0.0085", + "number_type": "local" + }, + { + "base_price": "0.022", + "current_price": "0.022", + "number_type": "toll free" + } + ], + "iso_country": "US", + "outbound_prefix_prices": [ + { + "base_price": "0.090", + "current_price": "0.090", + "destination_prefixes": [ + "1907" + ], + "friendly_name": "Programmable Outbound Minute - United States - Alaska", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": "0.013", + "current_price": "0.013", + "destination_prefixes": [ + "1808" + ], + "friendly_name": "Programmable Outbound Minute - United States - Hawaii", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": "0.013", + "current_price": "0.013", + "destination_prefixes": [ + "1800", + "1844", + "1855", + "1866", + "1877", + "1888" + ], + "friendly_name": "Programmable Outbound Minute - United States & Canada - Toll Free", + "origination_prefixes": [ + "ALL" + ] + }, + { + "base_price": "0.013", + "current_price": "0.013", + "destination_prefixes": [ + "1" + ], + "friendly_name": "Programmable Outbound Minute - United States & Canada", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Voice/Countries/US" + } + } } } }, @@ -827,10 +1096,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceCountry" } }, "/v2/Voice/Numbers/{DestinationNumber}": { @@ -846,8 +1112,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "Fetch pricing information for a specific destination and, optionally, origination phone number.", @@ -869,6 +1135,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "fetch": { + "value": "+18001234567" + } } } ], @@ -878,6 +1149,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/pricing.v2.voice.voice_number" + }, + "examples": { + "fetch": { + "value": { + "country": "United States", + "destination_number": "+18001234567", + "inbound_call_price": { + "base_price": null, + "current_price": null, + "number_type": null + }, + "iso_country": "US", + "origination_number": "+987654321", + "outbound_call_prices": [ + { + "base_price": "0.013", + "current_price": "0.013", + "origination_prefixes": [ + "ALL" + ] + } + ], + "price_unit": "USD", + "url": "https://pricing.twilio.com/v2/Voice/Numbers/+18001234567" + } + } } } }, @@ -889,10 +1186,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceNumber" } }, "/v2/Voice/Numbers": { @@ -908,8 +1202,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" } } }, @@ -917,11 +1211,5 @@ { "url": "https://pricing.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 5b3ad9a0..775c87bf 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "proxy.v1.service.session.interaction": { "type": "object", @@ -837,12 +843,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -858,7 +858,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -868,15 +868,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "type", "data" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Sessions/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session).", @@ -924,6 +924,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.interaction" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": "{\"body\":\"some message\"}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "inbound_participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_resource_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_resource_status": "sent", + "inbound_resource_type": "Message", + "inbound_resource_url": null, + "outbound_participant_sid": "KPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "outbound_resource_sid": "SMbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "outbound_resource_status": "sent", + "outbound_resource_type": "Message", + "outbound_resource_url": null, + "sid": "KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "message", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -935,10 +960,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchInteraction" }, "delete": { "description": "Delete a specific Interaction.", @@ -990,10 +1012,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions": { @@ -1002,15 +1021,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "type", "data" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Sessions/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page.", @@ -1082,16 +1101,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1100,17 +1121,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "interactions": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0", + "page_size": 50, + "key": "interactions" } } } @@ -1125,10 +1160,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions": { @@ -1137,15 +1169,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "type", "data" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new message Interaction to send directly from your system to one [Participant](https://www.twilio.com/docs/proxy/api/participant). The `inbound` properties for the Interaction will always be empty.", @@ -1193,6 +1225,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant.message_interaction" + }, + "examples": { + "create": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": "{\"body\":\"some message\"}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_participant_sid": null, + "inbound_resource_sid": null, + "inbound_resource_status": null, + "inbound_resource_type": null, + "inbound_resource_url": null, + "outbound_participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_status": "sent", + "outbound_resource_type": "Message", + "outbound_resource_url": null, + "sid": "KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "message", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1205,9 +1263,6 @@ } ], "operationId": "CreateMessageInteraction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1228,6 +1283,13 @@ "description": "Reserved. Not currently supported." } } + }, + "examples": { + "create": { + "value": { + "Body": "some message" + } + } } } } @@ -1323,16 +1385,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1341,17 +1405,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "interactions": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0", + "page_size": 50, + "key": "interactions" } } } @@ -1366,10 +1444,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessageInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListMessageInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}": { @@ -1378,15 +1453,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "type", "data" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1446,6 +1521,32 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant.message_interaction" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": "{\"body\":\"some message\"}", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "inbound_participant_sid": null, + "inbound_resource_sid": null, + "inbound_resource_status": null, + "inbound_resource_type": null, + "inbound_resource_url": null, + "outbound_participant_sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "outbound_resource_status": "sent", + "outbound_resource_type": "Message", + "outbound_resource_url": null, + "sid": "KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "message", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1457,10 +1558,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessageInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchMessageInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}": { @@ -1469,7 +1567,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1477,11 +1575,11 @@ "identifier", "proxy_identifier" ], - "pathType": "instance", "dependentProperties": { "message_interaction": "{service_sid: service_sid, session_sid: session_sid, participant_sid: sid}" }, - "parent": "/Services/{ServiceSid}/Sessions/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Participant.", @@ -1529,6 +1627,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant" + }, + "examples": { + "fetch": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "+14155551212", + "proxy_identifier": "+14155559999", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + }, + "fetchChannel": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "messenger:14155551212", + "proxy_identifier": "messenger:14155559999", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "a facebook user", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + } } } }, @@ -1540,10 +1678,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchParticipant" }, "delete": { "description": "Delete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only permanently deleted when the [Session](https://www.twilio.com/docs/proxy/api/session) is deleted.", @@ -1595,10 +1730,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteParticipant" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants": { @@ -1607,7 +1739,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1615,11 +1747,11 @@ "identifier", "proxy_identifier" ], - "pathType": "list", "dependentProperties": { "message_interaction": "{service_sid: service_sid, session_sid: session_sid, participant_sid: sid}" }, - "parent": "/Services/{ServiceSid}/Sessions/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Participants in a Session.", @@ -1691,16 +1823,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1709,18 +1843,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "page_size": 50, + "key": "participants" + }, + "participants": [] } } } @@ -1734,10 +1882,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "ListParticipant" }, "post": { "description": "Add a new Participant to the Session", @@ -1773,6 +1918,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session.participant" + }, + "examples": { + "create": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "+14155551212", + "proxy_identifier": "+14155559999", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + }, + "createChannel": { + "value": { + "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identifier": "messenger:123456", + "proxy_identifier": "messenger:987654532", + "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "a facebook user", + "date_deleted": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions" + } + } + } } } }, @@ -1785,9 +1970,6 @@ } ], "operationId": "CreateParticipant", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1818,6 +2000,21 @@ "required": [ "Identifier" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Identifier": "+14155551212" + } + }, + "createChannel": { + "value": { + "FriendlyName": "a facebook user", + "Identifier": "messenger:123456", + "ProxyIdentifier": "messenger:987654532" + } + } } } } @@ -1830,15 +2027,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "phone_number" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Add a Phone Number to a Service's Proxy Number Pool.", @@ -1862,6 +2059,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.phone_number" + }, + "examples": { + "create": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "+1987654321", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false, + "in_use": 0 + } + } } } }, @@ -1874,9 +2092,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1901,6 +2116,13 @@ "description": "Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information." } } + }, + "examples": { + "create": { + "value": { + "Sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1964,16 +2186,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1982,18 +2206,50 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "phone_numbers", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0" + }, + "phone_numbers": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "+1987654321", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false, + "in_use": 0 + } + ] } } } @@ -2007,10 +2263,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}": { @@ -2019,15 +2272,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "phone_number" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Phone Number from a Service.", @@ -2067,10 +2320,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePhoneNumber" }, "get": { "description": "Fetch a specific Phone Number.", @@ -2106,6 +2356,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.phone_number" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "12345", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false, + "in_use": 0 + } + } } } }, @@ -2117,10 +2388,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" }, "post": { "description": "Update a specific Proxy Number.", @@ -2156,6 +2424,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.phone_number" + }, + "examples": { + "update": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "phone_number": "12345", + "friendly_name": "Friendly Name", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": true, + "in_use": 0 + } + } } } }, @@ -2168,9 +2457,6 @@ } ], "operationId": "UpdatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2183,6 +2469,13 @@ "description": "Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information." } } + }, + "examples": { + "update": { + "value": { + "IsReserved": true + } + } } } } @@ -2195,19 +2488,19 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "session": "{service_sid: sid}", "phone_number": "{service_sid: sid}", "short_code": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Service.", @@ -2228,6 +2521,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My Service", + "default_ttl": 3600, + "callback_url": "http://www.example.com", + "geo_match_level": "country", + "number_selection_behavior": "prefer-sticky", + "intercept_callback_url": "http://www.example.com", + "out_of_session_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions", + "phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes" + } + } + } } } }, @@ -2239,10 +2556,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a specific Service.", @@ -2270,10 +2584,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Service.", @@ -2297,6 +2608,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service" + }, + "examples": { + "update": { + "value": { + "sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My Service", + "default_ttl": 3600, + "callback_url": "http://www.example.com", + "geo_match_level": "country", + "number_selection_behavior": "prefer-sticky", + "intercept_callback_url": "http://www.example.com", + "out_of_session_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions", + "phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes" + } + } + } } } }, @@ -2309,9 +2644,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2360,6 +2692,16 @@ "description": "The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship." } } + }, + "examples": { + "update": { + "value": { + "DefaultTtl": 3600, + "CallbackUrl": "http://www.example.com", + "UniqueName": "My Service", + "ChatInstanceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2372,19 +2714,19 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "date_created" ], - "pathType": "list", "dependentProperties": { "session": "{service_sid: sid}", "phone_number": "{service_sid: sid}", "short_code": "{service_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page.", @@ -2432,16 +2774,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2450,17 +2794,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "services": [], + "meta": { + "first_page_url": "https://proxy.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://proxy.twilio.com/v1/Services?PageSize=50&Page=0" } } } @@ -2475,10 +2833,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" }, "post": { "description": "Create a new Service for Twilio Proxy", @@ -2488,6 +2843,30 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My Service", + "default_ttl": 3600, + "callback_url": "http://www.example.com", + "geo_match_level": "country", + "number_selection_behavior": "prefer-sticky", + "intercept_callback_url": "http://www.example.com", + "out_of_session_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "sessions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions", + "phone_numbers": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers", + "short_codes": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes" + } + } + } } } }, @@ -2500,9 +2879,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2554,6 +2930,16 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "DefaultTtl": 3600, + "CallbackUrl": "http://www.example.com", + "UniqueName": "My Service", + "ChatInstanceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2566,7 +2952,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2574,12 +2960,12 @@ "date_started", "date_ended" ], - "pathType": "instance", "dependentProperties": { "interaction": "{service_sid: service_sid, session_sid: sid}", "participant": "{service_sid: service_sid, session_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Session.", @@ -2612,6 +2998,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "open", + "unique_name": "Order #1234", + "date_started": "2015-07-30T20:00:00Z", + "date_ended": "2015-07-30T20:00:00Z", + "date_last_interaction": "2015-07-30T20:00:00Z", + "date_expiry": "2015-07-30T20:00:00Z", + "ttl": 3600, + "mode": "voice-and-message", + "closed_reason": "", + "sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions", + "participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2623,10 +3034,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSession", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSession" }, "delete": { "description": "Delete a specific Session.", @@ -2666,10 +3074,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSession", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSession" }, "post": { "description": "Update a specific Session.", @@ -2705,6 +3110,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session" + }, + "examples": { + "update": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "in-progress", + "unique_name": "Order #1234", + "date_started": "2015-07-30T20:00:00Z", + "date_ended": "2015-07-30T20:00:00Z", + "date_last_interaction": "2015-07-30T20:00:00Z", + "date_expiry": "2015-07-30T20:00:00Z", + "ttl": 3600, + "mode": "voice-and-message", + "closed_reason": "", + "sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions", + "participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2717,9 +3147,6 @@ } ], "operationId": "UpdateSession", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2742,6 +3169,14 @@ "description": "The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600, + "Status": "in-progress" + } + } } } } @@ -2754,7 +3189,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2762,12 +3197,12 @@ "date_started", "date_ended" ], - "pathType": "list", "dependentProperties": { "interaction": "{service_sid: service_sid, session_sid: sid}", "participant": "{service_sid: service_sid, session_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page.", @@ -2827,16 +3262,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2845,17 +3282,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sessions": [], + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0", + "page_size": 50, + "key": "sessions" } } } @@ -2870,10 +3321,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSession", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSession" }, "post": { "description": "Create a new Session", @@ -2897,6 +3345,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.session" + }, + "examples": { + "create": { + "value": { + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "open", + "unique_name": "Order #1234", + "date_started": "2015-07-30T20:00:00Z", + "date_ended": "2015-07-30T20:00:00Z", + "date_last_interaction": "2015-07-30T20:00:00Z", + "date_expiry": "2015-07-30T20:00:00Z", + "ttl": 3600, + "mode": "voice-and-message", + "closed_reason": "", + "sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_updated": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions", + "participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants" + } + } + } } } }, @@ -2909,9 +3382,6 @@ } ], "operationId": "CreateSession", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2948,6 +3418,14 @@ "description": "The Participant objects to include in the new session." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 3600, + "UniqueName": "Order #1234" + } + } } } } @@ -2960,15 +3438,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "short_code", "iso_country" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Add a Short Code to the Proxy Number Pool for the Service.", @@ -2992,6 +3470,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.short_code" + }, + "examples": { + "create": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false + } + } } } }, @@ -3004,9 +3501,6 @@ } ], "operationId": "CreateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3025,6 +3519,13 @@ "required": [ "Sid" ] + }, + "examples": { + "create": { + "value": { + "Sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3088,16 +3589,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3106,18 +3609,48 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "short_codes", + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0" + }, + "short_codes": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false + } + ] } } } @@ -3131,10 +3664,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "ListShortCode" } }, "/v1/Services/{ServiceSid}/ShortCodes/{Sid}": { @@ -3143,15 +3673,15 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "short_code", "iso_country" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Short Code from a Service.", @@ -3191,10 +3721,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteShortCode" }, "get": { "description": "Fetch a specific Short Code.", @@ -3230,6 +3757,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.short_code" + }, + "examples": { + "fetch": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": false + } + } } } }, @@ -3241,10 +3787,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchShortCode" }, "post": { "description": "Update a specific Short Code.", @@ -3280,6 +3823,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/proxy.v1.service.short_code" + }, + "examples": { + "update": { + "value": { + "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "short_code": "12345", + "iso_country": "US", + "capabilities": { + "sms_outbound": true, + "voice_inbound": false + }, + "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "is_reserved": true + } + } } } }, @@ -3292,9 +3854,6 @@ } ], "operationId": "UpdateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3307,6 +3866,13 @@ "description": "Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information." } } + }, + "examples": { + "update": { + "value": { + "IsReserved": true + } + } } } } @@ -3318,11 +3884,5 @@ { "url": "https://proxy.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_routes_v2.json b/spec/json/twilio_routes_v2.json index 0a2a6904..0410f8dc 100644 --- a/spec/json/twilio_routes_v2.json +++ b/spec/json/twilio_routes_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "routes.v2.phone_number": { "type": "object", @@ -155,12 +161,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -176,7 +176,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -186,7 +186,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -214,6 +214,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.phone_number" + }, + "examples": { + "update": { + "value": { + "phone_number": "+18001234567", + "url": "https://routes.twilio.com/v2/PhoneNumbers/+18001234567", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -226,9 +240,6 @@ } ], "operationId": "UpdatePhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -245,6 +256,14 @@ "description": "A human readable description of this resource, up to 64 characters." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } @@ -269,6 +288,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.phone_number" + }, + "examples": { + "fetch": { + "value": { + "phone_number": "+18001234567", + "url": "https://routes.twilio.com/v2/PhoneNumbers/+18001234567", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -280,10 +313,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" } }, "/v2/SipDomains/{SipDomain}": { @@ -292,7 +322,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -320,6 +350,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.sip_domain" + }, + "examples": { + "update": { + "value": { + "url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com", + "sip_domain": "test.sip.twilio.com", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2020-08-07T22:29:24Z", + "date_updated": "2020-08-07T22:29:24Z" + } + } } } }, @@ -332,9 +376,6 @@ } ], "operationId": "UpdateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -351,6 +392,14 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } @@ -375,6 +424,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.sip_domain" + }, + "examples": { + "fetch": { + "value": { + "url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com", + "account_sid": "AC00000000000000000000000000000000", + "sid": "QQ00000000000000000000000000000000", + "sip_domain": "test.sip.twilio.com", + "friendly_name": "string", + "voice_region": "string", + "date_created": "2022-06-02T22:33:47Z", + "date_updated": "2022-06-02T22:33:47Z" + } + } } } }, @@ -386,10 +449,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipDomain" } }, "/v2/Trunks/{SipTrunkDomain}": { @@ -398,7 +458,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -426,6 +486,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.trunks" + }, + "examples": { + "update": { + "value": { + "sip_trunk_domain": "test.pstn.twilio.com", + "url": "https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com", + "sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_region": "au1", + "date_created": "2020-08-07T22:29:24Z", + "date_updated": "2020-08-07T22:29:24Z" + } + } } } }, @@ -438,9 +512,6 @@ } ], "operationId": "UpdateTrunks", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -457,6 +528,14 @@ "description": "A human readable description of this resource, up to 64 characters." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } @@ -481,6 +560,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/routes.v2.trunks" + }, + "examples": { + "fetch": { + "value": { + "sip_trunk_domain": "test.pstn.twilio.com", + "url": "https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com", + "account_sid": "AC00000000000000000000000000000000", + "sid": "QQ00000000000000000000000000000000", + "friendly_name": "string", + "voice_region": "string", + "date_created": "2022-06-02T22:33:47Z", + "date_updated": "2022-06-02T22:33:47Z" + } + } } } }, @@ -492,10 +585,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunks", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunks" } } }, @@ -503,11 +593,5 @@ { "url": "https://routes.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 77bc10b9..1731206f 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "serverless.v1.service.asset": { "type": "object", @@ -828,12 +834,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -849,7 +849,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -866,11 +866,11 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "asset_version": "{service_sid: service_sid, asset_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Assets.", @@ -927,16 +927,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -945,17 +947,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "assets": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0", + "key": "assets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0" } } } @@ -970,10 +986,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAsset" }, "post": { "description": "Create a new Asset resource.", @@ -994,6 +1007,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" + }, + "examples": { + "create": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "asset-friendly", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", + "links": { + "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -1006,9 +1035,6 @@ } ], "operationId": "CreateAsset", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1024,6 +1050,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "asset-friendly" + } + } } } } @@ -1043,11 +1076,11 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "asset_version": "{service_sid: service_sid, asset_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Asset resource.", @@ -1080,6 +1113,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "test-asset", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", + "links": { + "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -1091,10 +1140,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAsset" }, "delete": { "description": "Delete an Asset resource.", @@ -1131,10 +1177,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAsset" }, "post": { "description": "Update a specific Asset resource.", @@ -1167,6 +1210,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" + }, + "examples": { + "update": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "asset-friendly-update", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", + "links": { + "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -1179,9 +1238,6 @@ } ], "operationId": "UpdateAsset", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1197,6 +1253,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "asset-friendly-update" + } + } } } } @@ -1217,9 +1280,9 @@ "visibility", "date_created" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Assets/{Sid}", - "mountName": "asset_versions" + "mountName": "asset_versions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Asset Versions.", @@ -1288,16 +1351,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1306,17 +1371,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "asset_versions": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0", + "key": "asset_versions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0" } } } @@ -1331,10 +1410,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAssetVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAssetVersion" } }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}": { @@ -1351,9 +1427,9 @@ "visibility", "date_created" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Assets/{Sid}", - "mountName": "asset_versions" + "mountName": "asset_versions", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Asset Version.", @@ -1398,6 +1474,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset.asset_version" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_sid": "ZH00000000000000000000000000000000", + "path": "/test-path", + "visibility": "public", + "date_created": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000" + } + } } } }, @@ -1409,10 +1499,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAssetVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAssetVersion" } }, "/v1/Services/{ServiceSid}/Builds": { @@ -1428,11 +1515,11 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "build_status": "{service_sid: service_sid, sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Builds.", @@ -1489,16 +1576,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1507,17 +1596,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "builds": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0", + "key": "builds", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0" } } } @@ -1532,10 +1635,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBuild" }, "post": { "description": "Create a new Build resource. At least one function version or asset version is required.", @@ -1556,6 +1656,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build" + }, + "examples": { + "create": { + "value": { + "sid": "ZB00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_versions": [ + { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_sid": "ZH00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "path": "/asset-path", + "visibility": "PUBLIC" + } + ], + "function_versions": [ + { + "sid": "ZN00000000000000000000000000000001", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000001", + "date_created": "2018-11-10T20:00:00Z", + "path": "/function-path", + "visibility": "PUBLIC" + } + ], + "dependencies": [ + { + "name": "twilio", + "version": "3.29.2" + }, + { + "name": "@twilio/runtime-handler", + "version": "1.0.1" + } + ], + "runtime": "node16", + "status": "building", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000", + "links": { + "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" + } + } + } } } }, @@ -1568,9 +1717,6 @@ } ], "operationId": "CreateBuild", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1607,6 +1753,19 @@ "description": "The Runtime version that will be used to run the Build resource when it is deployed." } } + }, + "examples": { + "create": { + "value": { + "AssetVersions": [ + "ZN00000000000000000000000000000000" + ], + "FunctionVersions": [ + "ZN00000000000000000000000000000001" + ], + "Dependencies": "[{\"name\":\"twilio\", \"version\":\"3.29.2\"}, {\"name\":\"@twilio/runtime-handler\", \"version\": \"1.0.1\"}]" + } + } } } } @@ -1626,11 +1785,11 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "build_status": "{service_sid: service_sid, sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", @@ -1663,6 +1822,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZB00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_versions": [ + { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "asset_sid": "ZH00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "path": "/asset-path", + "visibility": "PUBLIC" + } + ], + "function_versions": [ + { + "sid": "ZN00000000000000000000000000000001", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000001", + "date_created": "2018-11-10T20:00:00Z", + "path": "/function-path", + "visibility": "PUBLIC" + } + ], + "dependencies": [ + { + "name": "twilio", + "version": "3.29.2" + }, + { + "name": "@twilio/runtime-handler", + "version": "1.0.1" + } + ], + "runtime": "node16", + "status": "building", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000", + "links": { + "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" + } + } + } } } }, @@ -1674,10 +1882,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBuild" }, "delete": { "description": "Delete a Build resource.", @@ -1714,10 +1919,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteBuild" } }, "/v1/Services/{ServiceSid}/Builds/{Sid}/Status": { @@ -1732,9 +1934,9 @@ "sid", "status" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Builds/{Sid}", - "mountName": "build_status" + "mountName": "build_status", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", @@ -1767,6 +1969,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build.build_status" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZB00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "status": "completed", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" + } + } } } }, @@ -1778,10 +1991,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBuildStatus", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBuildStatus" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments": { @@ -1797,8 +2007,8 @@ "build_sid", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Deployments.", @@ -1867,16 +2077,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1885,17 +2097,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "deployments": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0", + "key": "deployments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0" } } } @@ -1910,10 +2136,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployment", - "x-maturity": [ - "Beta" - ] + "operationId": "ListDeployment" }, "post": { "description": "Create a new Deployment.", @@ -1946,6 +2169,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" + }, + "examples": { + "create": { + "value": { + "sid": "ZD00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000" + } + } } } }, @@ -1958,9 +2195,6 @@ } ], "operationId": "CreateDeployment", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1976,6 +2210,13 @@ "description": "The SID of the Build for the Deployment." } } + }, + "examples": { + "create": { + "value": { + "BuildSid": "ZB00000000000000000000000000000000" + } + } } } } @@ -1995,8 +2236,8 @@ "build_sid", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Deployment.", @@ -2041,6 +2282,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZD00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000" + } + } } } }, @@ -2052,10 +2307,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployment", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDeployment" } }, "/v1/Services/{ServiceSid}/Environments": { @@ -2072,13 +2324,13 @@ "domain_name", "build_sid" ], - "pathType": "list", "dependentProperties": { "variable": "{service_sid: service_sid, environment_sid: sid}", "deployment": "{service_sid: service_sid, environment_sid: sid}", "log": "{service_sid: service_sid, environment_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all environments.", @@ -2135,16 +2387,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2153,17 +2407,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "environments": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0", + "key": "environments", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0" } } } @@ -2178,10 +2446,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEnvironment" }, "post": { "description": "Create a new environment.", @@ -2202,6 +2467,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment" + }, + "examples": { + "create": { + "value": { + "sid": "ZE00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "build_sid": null, + "unique_name": "staging", + "domain_suffix": "stage", + "domain_name": "foobar-1234-stage.twil.io", + "custom_domain_name": null, + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000", + "links": { + "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables", + "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments", + "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs" + } + } + } } } }, @@ -2214,9 +2501,6 @@ } ], "operationId": "CreateEnvironment", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2236,6 +2520,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "staging", + "DomainSuffix": "stage" + } + } } } } @@ -2256,13 +2548,13 @@ "domain_name", "build_sid" ], - "pathType": "instance", "dependentProperties": { "variable": "{service_sid: service_sid, environment_sid: sid}", "deployment": "{service_sid: service_sid, environment_sid: sid}", "log": "{service_sid: service_sid, environment_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific environment.", @@ -2295,6 +2587,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZE00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "unique_name": "testing-environment", + "domain_suffix": "testing", + "domain_name": "foobar-1234-testing.twil.io", + "custom_domain_name": null, + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000", + "links": { + "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables", + "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments", + "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs" + } + } + } } } }, @@ -2306,10 +2620,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEnvironment" }, "delete": { "description": "Delete a specific environment.", @@ -2346,10 +2657,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteEnvironment" } }, "/v1/Services/{ServiceSid}/Functions": { @@ -2365,11 +2673,11 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "function_version": "{service_sid: service_sid, function_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Functions.", @@ -2426,16 +2734,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2444,17 +2754,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "functions": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0", + "key": "functions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0" } } } @@ -2469,10 +2793,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFunction" }, "post": { "description": "Create a new Function resource.", @@ -2493,6 +2814,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" + }, + "examples": { + "create": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "function-friendly", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", + "links": { + "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -2505,9 +2842,6 @@ } ], "operationId": "CreateFunction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2523,6 +2857,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "function-friendly" + } + } } } } @@ -2542,11 +2883,11 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "function_version": "{service_sid: service_sid, function_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Function resource.", @@ -2579,6 +2920,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "test-function", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", + "links": { + "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -2590,10 +2947,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunction" }, "delete": { "description": "Delete a Function resource.", @@ -2630,10 +2984,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteFunction" }, "post": { "description": "Update a specific Function resource.", @@ -2666,6 +3017,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" + }, + "examples": { + "update": { + "value": { + "sid": "ZH00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "friendly_name": "function-friendly-update", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", + "links": { + "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" + } + } + } } } }, @@ -2678,9 +3045,6 @@ } ], "operationId": "UpdateFunction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2696,6 +3060,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "function-friendly-update" + } + } } } } @@ -2716,12 +3087,12 @@ "visibility", "date_created" ], - "pathType": "list", "dependentProperties": { "function_version_content": "{service_sid: service_sid, function_sid: function_sid, sid: sid}" }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", - "mountName": "function_versions" + "mountName": "function_versions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Function Version resources.", @@ -2790,16 +3161,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2808,17 +3181,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "function_versions": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0", + "key": "function_versions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0" } } } @@ -2833,10 +3220,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFunctionVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}": { @@ -2853,12 +3237,12 @@ "visibility", "date_created" ], - "pathType": "instance", "dependentProperties": { "function_version_content": "{service_sid: service_sid, function_sid: function_sid, sid: sid}" }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", - "mountName": "function_versions" + "mountName": "function_versions", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Function Version resource.", @@ -2903,6 +3287,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000000", + "path": "/test-path", + "visibility": "public", + "date_created": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000", + "links": { + "function_version_content": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content" + } + } + } } } }, @@ -2914,10 +3315,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunctionVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content": { @@ -2932,9 +3330,9 @@ "sid", "content" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}", - "mountName": "function_version_content" + "mountName": "function_version_content", + "pathType": "instance" }, "get": { "description": "Retrieve a the content of a specific Function Version resource.", @@ -2979,6 +3377,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version.function_version_content" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZN00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000000", + "content": "exports.handler = function (context, event, callback) {\n const request = require(\"request\");\n return request(\"http://www.google.com\", function (error, response, body) {\n callback(null, response.statusCode);\n });\n};", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content" + } + } } } }, @@ -2990,10 +3400,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunctionVersionContent", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunctionVersionContent" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs": { @@ -3005,8 +3412,8 @@ "description": "A record of an event that occurred related to a function invocation.", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all logs.", @@ -3041,6 +3448,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "ZH00000000000000000000000000000000" + } } }, { @@ -3050,6 +3462,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2018-11-10T20:00:00Z" + } } }, { @@ -3059,6 +3476,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2018-12-10T20:00:00Z" + } } }, { @@ -3104,16 +3526,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3122,17 +3546,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "logs": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0", + "key": "logs", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0" } } } @@ -3147,10 +3585,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListLog", - "x-maturity": [ - "Beta" - ] + "operationId": "ListLog" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}": { @@ -3162,8 +3597,8 @@ "description": "A record of an event that occurred related to a function invocation.", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific log.", @@ -3208,6 +3643,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.log" + }, + "examples": { + "fetch": { + "value": { + "sid": "NO00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "build_sid": "ZB00000000000000000000000000000000", + "deployment_sid": "ZD00000000000000000000000000000000", + "function_sid": "ZH00000000000000000000000000000000", + "request_sid": "RQ00000000000000000000000000000000", + "level": "warn", + "message": "This is a warning", + "date_created": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs/NO00000000000000000000000000000000" + } + } } } }, @@ -3219,10 +3672,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchLog", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchLog" } }, "/v1/Services": { @@ -3238,13 +3688,13 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "environment": "{service_sid: sid}", "function": "{service_sid: sid}", "asset": "{service_sid: sid}", "build": "{service_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Services.", @@ -3292,16 +3742,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3310,17 +3762,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "services": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services?PageSize=50&Page=0" } } } @@ -3335,10 +3801,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" }, "post": { "description": "Create a new Service resource.", @@ -3348,6 +3811,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" + }, + "examples": { + "create": { + "value": { + "sid": "ZS00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "service-friendly", + "unique_name": "service-unique", + "include_credentials": true, + "ui_editable": false, + "domain_base": "service-unique-1234", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", + "links": { + "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", + "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", + "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", + "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" + } + } + } } } }, @@ -3360,9 +3845,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3391,6 +3873,14 @@ "UniqueName", "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "service-friendly", + "UniqueName": "service-unique" + } + } } } } @@ -3410,13 +3900,13 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "environment": "{service_sid: sid}", "function": "{service_sid: sid}", "asset": "{service_sid: sid}", "build": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Retrieve a specific Service resource.", @@ -3437,6 +3927,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZS00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "test-service", + "unique_name": "test-service-1", + "include_credentials": true, + "ui_editable": false, + "domain_base": "test-service-1-1234", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", + "links": { + "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", + "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", + "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", + "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" + } + } + } } } }, @@ -3448,10 +3960,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a Service resource.", @@ -3476,10 +3985,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Service resource.", @@ -3500,6 +4006,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" + }, + "examples": { + "update": { + "value": { + "sid": "ZS00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "service-friendly-update", + "unique_name": "service-unique-update", + "include_credentials": true, + "ui_editable": true, + "domain_base": "service-unique-update-1234", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", + "links": { + "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", + "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", + "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", + "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" + } + } + } } } }, @@ -3512,9 +4040,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3535,6 +4060,15 @@ "description": "Whether the Service resource's properties and subresources can be edited via the UI. The default value is `false`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "service-friendly-update", + "IncludeCredentials": true, + "UiEditable": true + } + } } } } @@ -3554,8 +4088,8 @@ "key", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Variables.", @@ -3624,16 +4158,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3642,17 +4178,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "variables": [], + "meta": { + "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0", + "key": "variables", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0" } } } @@ -3667,10 +4217,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVariable" }, "post": { "description": "Create a new Variable.", @@ -3703,6 +4250,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" + }, + "examples": { + "create": { + "value": { + "sid": "ZV00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "key": "new-key", + "value": "new-value", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" + } + } } } }, @@ -3715,9 +4277,6 @@ } ], "operationId": "CreateVariable", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3738,6 +4297,14 @@ "Key", "Value" ] + }, + "examples": { + "create": { + "value": { + "Key": "new-key", + "Value": "new-value" + } + } } } } @@ -3757,8 +4324,8 @@ "key", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Variable.", @@ -3803,6 +4370,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" + }, + "examples": { + "fetch": { + "value": { + "sid": "ZV00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "key": "test-key", + "value": "test-value", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-10T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" + } + } } } }, @@ -3814,10 +4396,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVariable" }, "post": { "description": "Update a specific Variable.", @@ -3862,6 +4441,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" + }, + "examples": { + "update": { + "value": { + "sid": "ZV00000000000000000000000000000000", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ZS00000000000000000000000000000000", + "environment_sid": "ZE00000000000000000000000000000000", + "key": "update-key", + "value": "update-value", + "date_created": "2018-11-10T20:00:00Z", + "date_updated": "2018-11-11T20:00:00Z", + "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" + } + } } } }, @@ -3874,9 +4468,6 @@ } ], "operationId": "UpdateVariable", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3893,6 +4484,14 @@ "description": "A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size." } } + }, + "examples": { + "update": { + "value": { + "Key": "update-key", + "Value": "update-value" + } + } } } } @@ -3945,10 +4544,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteVariable" } } }, @@ -3956,11 +4552,5 @@ { "url": "https://serverless.twilio.com" } - ], - "x-maturity": [ - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 8b8d7336..f33c869c 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "studio.v1.flow.engagement": { "type": "object", @@ -567,12 +573,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -588,7 +588,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -606,12 +606,12 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "step": "{flow_sid: flow_sid, engagement_sid: sid}", "engagement_context": "{flow_sid: flow_sid, engagement_sid: sid}" }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Engagements for the Flow.", @@ -671,16 +671,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -689,18 +691,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0", + "page_size": 50, + "key": "engagements" + }, + "engagements": [] } } } @@ -714,10 +730,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "ListEngagement" }, "post": { "description": "Triggers a new Engagement for the Flow", @@ -741,6 +754,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement" + }, + "examples": { + "create": { + "value": { + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+18001234567", + "status": "active", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "engagement_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -753,9 +786,6 @@ } ], "operationId": "CreateEngagement", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -781,6 +811,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -801,12 +840,12 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "step": "{flow_sid: flow_sid, engagement_sid: sid}", "engagement_context": "{flow_sid: flow_sid, engagement_sid: sid}" }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Engagement", @@ -842,6 +881,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement" + }, + "examples": { + "fetch": { + "value": { + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "context": {}, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "engagement_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -853,10 +912,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEngagement" }, "delete": { "description": "Delete this Engagement and all Steps relating to it.", @@ -896,10 +952,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEngagement" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context": { @@ -913,9 +966,9 @@ "defaultOutputProperties": [ "context" ], - "pathType": "instance", "parent": "/Flows/{FlowSid}/Engagements/{Sid}", - "mountName": "engagement_context" + "mountName": "engagement_context", + "pathType": "instance" }, "get": { "description": "Retrieve the most recent context for an Engagement.", @@ -951,6 +1004,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement.engagement_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -962,10 +1028,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEngagementContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEngagementContext" } }, "/v1/Flows/{FlowSid}/Executions": { @@ -982,12 +1045,12 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Executions for the Flow.", @@ -1065,16 +1128,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1083,18 +1148,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page_size": 50, + "key": "executions" + }, + "executions": [] } } } @@ -1108,10 +1187,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecution", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecution" }, "post": { "description": "Triggers a new Execution for the Flow", @@ -1135,6 +1211,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "examples": { + "create": { + "value": { + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+18001234567", + "status": "active", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1147,9 +1243,6 @@ } ], "operationId": "CreateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1175,6 +1268,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -1195,12 +1297,12 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Execution", @@ -1236,6 +1338,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "examples": { + "fetch": { + "value": { + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "context": {}, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1247,10 +1369,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecution", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecution" }, "delete": { "description": "Delete the Execution and all Steps relating to it.", @@ -1290,10 +1409,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteExecution", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteExecution" }, "post": { "description": "Update the status of an Execution to `ended`.", @@ -1329,6 +1445,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution" + }, + "examples": { + "update": { + "value": { + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1341,9 +1477,6 @@ } ], "operationId": "UpdateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1360,6 +1493,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -1377,9 +1517,9 @@ "defaultOutputProperties": [ "context" ], - "pathType": "instance", "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "mountName": "execution_context" + "mountName": "execution_context", + "pathType": "instance" }, "get": { "description": "Retrieve the most recent context for an Execution.", @@ -1415,6 +1555,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution.execution_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -1426,10 +1579,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionContext" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { @@ -1445,12 +1595,12 @@ "name", "date_created" ], - "pathType": "list", "dependentProperties": { "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Execution.", @@ -1522,16 +1672,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1540,18 +1692,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page_size": 50, + "key": "steps" + }, + "steps": [] } } } @@ -1565,10 +1731,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecutionStep" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { @@ -1584,12 +1747,12 @@ "name", "date_created" ], - "pathType": "instance", "dependentProperties": { "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", @@ -1637,6 +1800,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" + }, + "examples": { + "fetch": { + "value": { + "sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parent_step_sid": null, + "name": "incomingRequest", + "context": {}, + "transitioned_from": "Trigger", + "transitioned_to": "Ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "step_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1648,10 +1832,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStep" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { @@ -1665,10 +1846,10 @@ "defaultOutputProperties": [ "context" ], - "pathType": "instance", "parent": "/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}", "mountName": "step_context", - "className": "execution_step_context" + "className": "execution_step_context", + "pathType": "instance" }, "get": { "description": "Retrieve the context for an Execution Step.", @@ -1716,6 +1897,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "step_sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -1727,10 +1922,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStepContext" } }, "/v1/Flows": { @@ -1747,11 +1939,11 @@ "status", "version" ], - "pathType": "list", "dependentProperties": { "engagement": "{flow_sid: sid}", "execution": "{flow_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Flows.", @@ -1799,16 +1991,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1817,18 +2011,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0", + "page_size": 50, + "key": "flows" + }, + "flows": [] } } } @@ -1842,10 +2050,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlow" } }, "/v1/Flows/{Sid}": { @@ -1862,11 +2067,11 @@ "status", "version" ], - "pathType": "instance", "dependentProperties": { "engagement": "{flow_sid: sid}", "execution": "{flow_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Retrieve a specific Flow.", @@ -1890,6 +2095,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "status": "published", + "version": 1, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "engagements": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements", + "executions": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1901,10 +2124,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlow" }, "delete": { "description": "Delete a specific Flow.", @@ -1932,10 +2152,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlow" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps": { @@ -1952,11 +2169,11 @@ "transitioned_from", "transitioned_to" ], - "pathType": "list", "dependentProperties": { "step_context": "{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: sid}" }, - "parent": "/Flows/{FlowSid}/Engagements/{Sid}" + "parent": "/Flows/{FlowSid}/Engagements/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Engagement.", @@ -2028,16 +2245,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2046,18 +2265,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page_size": 50, + "key": "steps" + }, + "steps": [] } } } @@ -2071,10 +2304,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListStep" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}": { @@ -2091,11 +2321,11 @@ "transitioned_from", "transitioned_to" ], - "pathType": "instance", "dependentProperties": { "step_context": "{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: sid}" }, - "parent": "/Flows/{FlowSid}/Engagements/{Sid}" + "parent": "/Flows/{FlowSid}/Engagements/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", @@ -2143,6 +2373,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement.step" + }, + "examples": { + "fetch": { + "value": { + "sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "incomingRequest", + "context": {}, + "transitioned_from": "Trigger", + "transitioned_to": "Ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "step_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -2154,10 +2404,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchStep" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context": { @@ -2171,9 +2418,9 @@ "defaultOutputProperties": [ "context" ], - "pathType": "instance", "parent": "/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}", - "mountName": "step_context" + "mountName": "step_context", + "pathType": "instance" }, "get": { "description": "Retrieve the context for an Engagement Step.", @@ -2221,6 +2468,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v1.flow.engagement.step.step_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "step_sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -2232,10 +2493,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchStepContext" } } }, @@ -2243,11 +2501,5 @@ { "url": "https://studio.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index b49f0d90..9018a1e7 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "studio.v2.flow.execution": { "type": "object", @@ -467,12 +473,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -488,7 +488,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -505,12 +505,12 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Executions for the Flow.", @@ -588,16 +588,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -606,18 +608,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0", + "page_size": 50, + "key": "executions" + }, + "executions": [] } } } @@ -631,10 +647,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecution", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecution" }, "post": { "description": "Triggers a new Execution for the Flow", @@ -658,6 +671,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "examples": { + "create": { + "value": { + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_channel_address": "+18001234567", + "status": "active", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -670,9 +702,6 @@ } ], "operationId": "CreateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -698,6 +727,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -717,12 +755,12 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "execution_step": "{flow_sid: flow_sid, execution_sid: sid}", "execution_context": "{flow_sid: flow_sid, execution_sid: sid}" }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Execution", @@ -758,6 +796,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "examples": { + "fetch": { + "value": { + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "contact_channel_address": "+14155555555", + "status": "ended", + "context": {}, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -769,10 +826,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecution", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecution" }, "delete": { "description": "Delete the Execution and all Steps relating to it.", @@ -812,10 +866,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteExecution", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteExecution" }, "post": { "description": "Update the status of an Execution to `ended`.", @@ -851,6 +902,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution" + }, + "examples": { + "update": { + "value": { + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": {}, + "contact_channel_address": "+14155555555", + "status": "ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "links": { + "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps", + "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -863,9 +933,6 @@ } ], "operationId": "UpdateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -882,6 +949,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -899,9 +973,9 @@ "defaultOutputProperties": [ "context" ], - "pathType": "instance", "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "mountName": "execution_context" + "mountName": "execution_context", + "pathType": "instance" }, "get": { "description": "Retrieve the most recent context for an Execution.", @@ -937,6 +1011,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution.execution_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -948,10 +1035,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionContext" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { @@ -967,12 +1051,12 @@ "name", "date_created" ], - "pathType": "list", "dependentProperties": { "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Execution.", @@ -1044,16 +1128,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1062,18 +1148,32 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0", + "page_size": 50, + "key": "steps" + }, + "steps": [] } } } @@ -1087,10 +1187,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecutionStep" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { @@ -1106,12 +1203,12 @@ "name", "date_created" ], - "pathType": "instance", "dependentProperties": { "execution_step_context": "{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}" }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", @@ -1159,6 +1256,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" + }, + "examples": { + "fetch": { + "value": { + "sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parent_step_sid": null, + "name": "incomingRequest", + "context": {}, + "transitioned_from": "Trigger", + "transitioned_to": "Ended", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "step_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } + } } } }, @@ -1170,10 +1288,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStep" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { @@ -1187,10 +1302,10 @@ "defaultOutputProperties": [ "context" ], - "pathType": "instance", "parent": "/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}", "mountName": "step_context", - "className": "execution_step_context" + "className": "execution_step_context", + "pathType": "instance" }, "get": { "description": "Retrieve the context for an Execution Step.", @@ -1238,6 +1353,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "context": { + "foo": "bar" + }, + "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "execution_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "step_sid": "FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context" + } + } } } }, @@ -1249,10 +1378,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStepContext" } }, "/v2/Flows": { @@ -1269,12 +1395,12 @@ "status", "revision" ], - "pathType": "list", "dependentProperties": { "flow_revision": "{sid: sid}", "flow_test_user": "{sid: sid}", "execution": "{flow_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a Flow.", @@ -1284,6 +1410,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow" + }, + "examples": { + "create": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "definition": { + "initial_state": "Trigger" + }, + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "commit_message": null, + "valid": true, + "errors": [], + "warnings": [], + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1296,9 +1449,6 @@ } ], "operationId": "CreateFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1328,6 +1478,15 @@ "Status", "Definition" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1379,16 +1538,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1397,18 +1558,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows?PageSize=50&Page=0", + "page_size": 50, + "key": "flows" + }, + "flows": [ + { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "definition": null, + "commit_message": null, + "valid": null, + "errors": null, + "warnings": null, + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + ] } } } @@ -1422,10 +1619,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlow" } }, "/v2/Flows/{Sid}": { @@ -1442,12 +1636,12 @@ "status", "revision" ], - "pathType": "instance", "dependentProperties": { "flow_revision": "{sid: sid}", "flow_test_user": "{sid: sid}", "execution": "{flow_sid: sid}" - } + }, + "pathType": "instance" }, "post": { "description": "Update a Flow.", @@ -1471,6 +1665,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow" + }, + "examples": { + "update": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "definition": { + "initial_state": "Trigger" + }, + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "commit_message": null, + "valid": true, + "errors": [], + "warnings": [], + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1483,9 +1704,6 @@ } ], "operationId": "UpdateFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1513,6 +1731,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1540,6 +1767,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "definition": { + "initial_state": "Trigger" + }, + "status": "published", + "revision": 1, + "commit_message": "commit", + "valid": true, + "errors": [], + "warnings": [], + "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers", + "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions", + "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions" + } + } + } } } }, @@ -1551,10 +1805,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlow" }, "delete": { "description": "Delete a specific Flow.", @@ -1582,10 +1833,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlow" } }, "/v2/Flows/{Sid}/Revisions": { @@ -1602,9 +1850,9 @@ "status", "revision" ], - "pathType": "list", "parent": "/Flows/{Sid}", - "className": "flow_revision" + "className": "flow_revision", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Flows revisions.", @@ -1664,16 +1912,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1682,18 +1932,47 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "previous_page_url": null, + "next_page_url": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0", + "page": 0, + "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0", + "page_size": 50, + "key": "revisions" + }, + "revisions": [ + { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "definition": null, + "commit_message": null, + "valid": null, + "errors": null, + "date_created": "2017-11-06T12:00:00Z", + "date_updated": "2017-11-06T12:00:00Z", + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1" + } + ] } } } @@ -1707,10 +1986,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlowRevision", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlowRevision" } }, "/v2/Flows/{Sid}/Revisions/{Revision}": { @@ -1727,9 +2003,9 @@ "status", "revision" ], - "pathType": "instance", "parent": "/Flows/{Sid}", - "className": "flow_revision" + "className": "flow_revision", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Flow revision.", @@ -1762,6 +2038,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.flow_revision" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "definition": { + "initial_state": "Trigger" + }, + "friendly_name": "Test Flow", + "status": "published", + "revision": 1, + "commit_message": null, + "valid": true, + "errors": [], + "date_created": "2017-11-06T12:00:00Z", + "date_updated": null, + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1" + } + } } } }, @@ -1773,10 +2069,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlowRevision", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlowRevision" } }, "/v2/Flows/Validate": { @@ -1790,8 +2083,8 @@ "defaultOutputProperties": [ "valid" ], - "pathType": "list", - "mountName": "flow_validate" + "mountName": "flow_validate", + "pathType": "list" }, "post": { "description": "Validate flow JSON definition", @@ -1801,6 +2094,13 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow_validate" + }, + "examples": { + "update": { + "value": { + "valid": true + } + } } } }, @@ -1813,9 +2113,6 @@ } ], "operationId": "UpdateFlowValidate", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1845,6 +2142,15 @@ "Status", "Definition" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1862,9 +2168,9 @@ "defaultOutputProperties": [ "test_users" ], - "pathType": "instance", "parent": "/Flows/{Sid}", - "className": "flow_test_user" + "className": "flow_test_user", + "pathType": "instance" }, "get": { "description": "Fetch flow test users", @@ -1888,6 +2194,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.test_user" + }, + "examples": { + "fetch": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "test_users": [ + "user1", + "user2" + ], + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers" + } + } } } }, @@ -1899,10 +2217,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTestUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTestUser" }, "post": { "description": "Update flow test users", @@ -1926,6 +2241,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow.test_user" + }, + "examples": { + "update": { + "value": { + "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "test_users": [ + "user1", + "user2" + ], + "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers" + } + } } } }, @@ -1938,9 +2265,6 @@ } ], "operationId": "UpdateTestUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1959,6 +2283,16 @@ "required": [ "TestUsers" ] + }, + "examples": { + "update": { + "value": { + "TestUsers": [ + "user1", + "user2" + ] + } + } } } } @@ -1970,11 +2304,5 @@ { "url": "https://studio.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 8e91dea5..4730125f 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "supersim.v1.sim.billing_period": { "type": "object", @@ -875,12 +881,6 @@ "time" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -896,7 +896,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -915,8 +915,8 @@ "end_time", "period_type" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of Billing Periods for a Super SIM.", @@ -973,16 +973,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -991,17 +993,81 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "billing_periods": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "next_page_url": null, + "key": "billing_periods" + } + } + }, + "readFullActivePeriod": { + "value": { + "billing_periods": [ + { + "sid": "HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period_type": "active", + "start_time": "2021-06-09T13:18:15Z", + "end_time": "2021-07-09T13:18:15Z", + "date_created": "2021-06-09T13:18:16Z", + "date_updated": "2021-06-09T13:18:16Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "next_page_url": null, + "key": "billing_periods" + } + } + }, + "readFullReadyPeriod": { + "value": { + "billing_periods": [ + { + "sid": "HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period_type": "ready", + "start_time": "2021-06-09T13:18:15Z", + "end_time": "2021-07-09T13:18:15Z", + "date_created": "2021-06-09T13:18:16Z", + "date_updated": "2021-06-09T13:18:16Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0", + "next_page_url": null, + "key": "billing_periods" } } } @@ -1016,10 +1082,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBillingPeriod", - "x-maturity": [ - "GA" - ] + "operationId": "ListBillingPeriod" } }, "/v1/ESimProfiles": { @@ -1034,8 +1097,8 @@ "sid", "status" ], - "pathType": "list", - "mountName": "esim_profiles" + "mountName": "esim_profiles", + "pathType": "list" }, "post": { "description": "Order an eSIM Profile.", @@ -1045,6 +1108,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.esim_profile" + }, + "examples": { + "createDefaultSmdp": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": null, + "sim_sid": null, + "status": "new", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": null, + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createActivationCode": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": null, + "sim_sid": null, + "status": "new", + "eid": null, + "smdp_plus_address": null, + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCallback": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": null, + "sim_sid": null, + "status": "reserving", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": null, + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1057,9 +1176,6 @@ } ], "operationId": "CreateEsimProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1093,6 +1209,25 @@ "description": "Identifier of the eUICC that will claim the eSIM Profile." } } + }, + "examples": { + "createDefaultSmdp": { + "value": { + "Eid": "89049032005008882600033489aaaaaa" + } + }, + "createActivationCode": { + "value": { + "GenerateMatchingId": true + } + }, + "createWithCallback": { + "value": { + "Eid": "89049032005008882600033489aaaaaa", + "CallbackUrl": "http://callback.twilio.com", + "CallbackMethod": "POST" + } + } } } } @@ -1107,6 +1242,11 @@ "description": "List the eSIM Profiles that have been associated with an EId.", "schema": { "type": "string" + }, + "examples": { + "readByEid": { + "value": "89049032005008882600033489aaaaaa" + } } }, { @@ -1115,6 +1255,11 @@ "description": "Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.", "schema": { "type": "string" + }, + "examples": { + "readBySimSid": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1124,6 +1269,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/esim_profile_enum_status" + }, + "examples": { + "readByStatus": { + "value": "downloaded" + } } }, { @@ -1169,16 +1319,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1187,17 +1339,141 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0" + } + } + }, + "readByEid": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0" + } + } + }, + "readBySimSid": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + } + } + }, + "readByStatus": { + "value": { + "esim_profiles": [ + { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "downloaded", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0", + "key": "esim_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0" } } } @@ -1212,10 +1488,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEsimProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEsimProfile" } }, "/v1/ESimProfiles/{Sid}": { @@ -1230,8 +1503,8 @@ "sid", "status" ], - "pathType": "instance", - "mountName": "esim_profiles" + "mountName": "esim_profiles", + "pathType": "instance" }, "get": { "description": "Fetch an eSIM Profile.", @@ -1252,6 +1525,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.esim_profile" + }, + "examples": { + "fetchDefaultSmdp": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": "89049032005008882600033489aaaaaa", + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": null, + "activation_code": null, + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchActivationCode": { + "value": { + "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "8988307aaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "available", + "eid": null, + "smdp_plus_address": "sm-dp-plus.twilio.com", + "matching_id": "AAAAA-BBBBB-CCCCC-DDDDD-EEEEE", + "activation_code": "1$SM-DP-PLUS.TWILIO.COM$AAAAA-BBBBB-CCCCC-DDDDD-EEEEE", + "error_code": null, + "error_message": null, + "date_created": "2020-09-01T20:00:00Z", + "date_updated": "2020-09-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1263,10 +1574,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEsimProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEsimProfile" } }, "/v1/Fleets": { @@ -1292,6 +1600,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.fleet" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 500, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "GET", + "sms_commands_url": "https://google.com", + "ip_commands_method": "GET", + "ip_commands_url": "https://google.com", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1304,9 +1633,6 @@ } ], "operationId": "CreateFleet", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1374,6 +1700,21 @@ "required": [ "NetworkAccessProfile" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "DataEnabled": true, + "DataLimit": 500, + "SmsCommandsEnabled": true, + "SmsCommandsMethod": "GET", + "SmsCommandsUrl": "https://google.com", + "IpCommandsMethod": "GET", + "IpCommandsUrl": "https://google.com", + "NetworkAccessProfile": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1388,6 +1729,14 @@ "description": "The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1433,16 +1782,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1451,19 +1802,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "fleets": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "fleets", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "fleets": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "Pilot Fleet", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-10-15T20:00:00Z", + "date_updated": "2019-10-15T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "POST", + "sms_commands_url": null, + "ip_commands_method": "POST", + "ip_commands_url": null, + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -1476,10 +1873,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFleet", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFleet" } }, "/v1/Fleets/{Sid}": { @@ -1516,6 +1910,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.fleet" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "POST", + "sms_commands_url": null, + "ip_commands_method": "POST", + "ip_commands_url": null, + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1527,10 +1942,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFleet", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFleet" }, "post": { "description": "Updates the given properties of a Super SIM Fleet instance from your account.", @@ -1551,6 +1963,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.fleet" + }, + "examples": { + "updateUniqueNameAndDataLimit": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "GPS Trackers Fleet 5GB", + "data_enabled": true, + "data_limit": 5000, + "data_metering": "payg", + "date_created": "2019-10-15T20:00:00Z", + "date_updated": "2019-10-15T20:00:00Z", + "sms_commands_enabled": true, + "sms_commands_method": "POST", + "sms_commands_url": null, + "ip_commands_method": "POST", + "ip_commands_url": null, + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1563,9 +1996,6 @@ } ], "operationId": "UpdateFleet", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1622,6 +2052,15 @@ "description": "The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000)." } } + }, + "examples": { + "updateUniqueNameAndDataLimit": { + "value": { + "UniqueName": "GPS Trackers Fleet 5GB", + "NetworkAccessProfile": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DataLimit": 5000 + } + } } } } @@ -1651,6 +2090,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.ip_command" + }, + "examples": { + "createFull": { + "value": { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "queued", + "direction": "to_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createMinimal": { + "value": { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "queued", + "direction": "to_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1663,9 +2138,6 @@ } ], "operationId": "CreateIpCommand", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1714,6 +2186,25 @@ "Payload", "DevicePort" ] + }, + "examples": { + "createFull": { + "value": { + "Sim": "sim", + "Payload": "checkin: firmware update", + "DevicePort": 100, + "PayloadType": "text", + "CallbackUrl": "http://www.example.com", + "CallbackMethod": "GET" + } + }, + "createMinimal": { + "value": { + "Sim": "sim", + "Payload": "checkin: firmware update", + "DevicePort": 100 + } + } } } } @@ -1728,6 +2219,14 @@ "description": "The SID or unique name of the Sim resource that IP Command was sent to or from.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1745,6 +2244,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/ip_command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "received" + }, + "readFull": { + "value": "received" + } } }, { @@ -1799,16 +2306,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1817,19 +2326,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "ip_commands": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "ip_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "ip_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "ip_commands": [ + { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "received", + "direction": "from_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -1842,10 +2395,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIpCommand" } }, "/v1/IpCommands/{Sid}": { @@ -1885,6 +2435,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.ip_command" + }, + "examples": { + "fetch": { + "value": { + "sid": "HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_iccid": "89883070000123456789", + "status": "queued", + "direction": "to_sim", + "device_ip": "100.64.0.123", + "device_port": 100, + "payload_type": "text", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1896,10 +2465,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIpCommand" } }, "/v1/Networks/{Sid}": { @@ -1937,6 +2503,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network" + }, + "examples": { + "fetch": { + "value": { + "friendly_name": "AT&T", + "iso_country": "US", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1948,10 +2530,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetwork" } }, "/v1/Networks": { @@ -1976,6 +2555,11 @@ "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources to read.", "schema": { "type": "string" + }, + "examples": { + "readWithFilters": { + "value": "US" + } } }, { @@ -1984,6 +2568,11 @@ "description": "The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.", "schema": { "type": "string" + }, + "examples": { + "readWithFilters": { + "value": "310" + } } }, { @@ -1992,6 +2581,11 @@ "description": "The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.", "schema": { "type": "string" + }, + "examples": { + "readWithFilters": { + "value": "410" + } } }, { @@ -2037,16 +2631,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2055,18 +2651,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "read": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0", + "key": "networks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0" + }, + "networks": [ + { + "friendly_name": "AT&T", + "iso_country": "US", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readWithFilters": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0", + "key": "networks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0" + }, + "networks": [ + { + "friendly_name": "AT&T", + "iso_country": "US", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2080,10 +2730,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetwork" } }, "/v1/NetworkAccessProfiles": { @@ -2092,17 +2739,17 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "fleets_count" ], - "pathType": "list", "dependentProperties": { "network_access_profile_network": "{network_access_profile_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new Network Access Profile", @@ -2112,6 +2759,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile" + }, + "examples": { + "createMinimal": { + "value": { + "unique_name": null, + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + }, + "createWithNameAndNetworks": { + "value": { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + } } } }, @@ -2124,9 +2799,6 @@ } ], "operationId": "CreateNetworkAccessProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2146,6 +2818,20 @@ "description": "List of Network SIDs that this Network Access Profile will allow connections to." } } + }, + "examples": { + "createMinimal": { + "value": {} + }, + "createWithNameAndNetworks": { + "value": { + "UniqueName": "My Network Access Profile", + "Networks": [ + "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ] + } + } } } } @@ -2197,16 +2883,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2215,19 +2903,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "network_access_profiles": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0", + "key": "network_access_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0", + "key": "network_access_profiles", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0" + }, + "network_access_profiles": [ + { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + ] + } } } } @@ -2240,10 +2968,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetworkAccessProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetworkAccessProfile" } }, "/v1/NetworkAccessProfiles/{Sid}": { @@ -2252,17 +2977,17 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "fleets_count" ], - "pathType": "instance", "dependentProperties": { "network_access_profile_network": "{network_access_profile_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Network Access Profile instance from your account.", @@ -2283,6 +3008,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile" + }, + "examples": { + "fetch": { + "value": { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + } } } }, @@ -2294,10 +3034,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetworkAccessProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetworkAccessProfile" }, "post": { "description": "Updates the given properties of a Network Access Profile in your account.", @@ -2318,6 +3055,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile" + }, + "examples": { + "updateUniqueName": { + "value": { + "unique_name": "My Network Access Profile", + "sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-05-01T20:00:00Z", + "date_updated": "2020-05-01T20:00:00Z", + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks" + } + } + } } } }, @@ -2330,9 +3082,6 @@ } ], "operationId": "UpdateNetworkAccessProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2345,6 +3094,13 @@ "description": "The new unique name of the Network Access Profile." } } + }, + "examples": { + "updateUniqueName": { + "value": { + "UniqueName": "My Network Access Profile" + } + } } } } @@ -2362,9 +3118,9 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/NetworkAccessProfiles/{Sid}", - "className": "network_access_profile_network" + "className": "network_access_profile_network", + "pathType": "list" }, "get": { "description": "Retrieve a list of Network Access Profile resource's Network resource.", @@ -2421,16 +3177,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2439,18 +3197,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0", + "key": "networks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0" + }, + "networks": [ + { + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "AT&T", + "iso_country": "us", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -2464,10 +3250,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetworkAccessProfileNetwork" }, "post": { "description": "Add a Network resource to the Network Access Profile resource.", @@ -2488,6 +3271,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network" + }, + "examples": { + "create": { + "value": { + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "AT&T", + "iso_country": "us", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2500,9 +3300,6 @@ } ], "operationId": "CreateNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2521,7 +3318,14 @@ "required": [ "Network" ] - } + }, + "examples": { + "create": { + "value": { + "Network": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } } @@ -2538,9 +3342,9 @@ "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/NetworkAccessProfiles/{Sid}", - "className": "network_access_profile_network" + "className": "network_access_profile_network", + "pathType": "instance" }, "delete": { "description": "Remove a Network resource from the Network Access Profile resource's.", @@ -2580,10 +3384,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteNetworkAccessProfileNetwork" }, "get": { "description": "Fetch a Network Access Profile resource's Network resource.", @@ -2616,6 +3417,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network" + }, + "examples": { + "fetch": { + "value": { + "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "AT&T", + "iso_country": "us", + "identifiers": [ + { + "mcc": "310", + "mnc": "410" + } + ], + "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2627,10 +3445,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetworkAccessProfileNetwork" } }, "/v1/SettingsUpdates": { @@ -2639,7 +3454,7 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2658,6 +3473,14 @@ "description": "Filter the Settings Updates by a Super SIM's SID or UniqueName.", "schema": { "type": "string" + }, + "examples": { + "readSimOnly": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2667,6 +3490,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/settings_update_enum_status" + }, + "examples": { + "readStatusOnly": { + "value": "scheduled" + }, + "readFull": { + "value": "scheduled" + } } }, { @@ -2712,16 +3543,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2730,17 +3563,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "settings_updates": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" + } + } + }, + "readSimOnly": { + "value": { + "settings_updates": [ + { + "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "successful", + "packages": [ + { + "name": "base-settings", + "version": "1.0.0", + "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings" + } + ], + "date_completed": "2015-07-30T20:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" + } + } + }, + "readStatusOnly": { + "value": { + "settings_updates": [ + { + "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "packages": [ + { + "name": "base-settings", + "version": "1.0.0", + "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings" + } + ], + "date_completed": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" + } + } + }, + "readFull": { + "value": { + "settings_updates": [ + { + "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "scheduled", + "packages": [ + { + "name": "base-settings", + "version": "1.0.0", + "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings" + } + ], + "date_completed": null, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "settings_updates" } } } @@ -2755,10 +3695,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSettingsUpdate", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSettingsUpdate" } }, "/v1/Sims": { @@ -2774,11 +3711,11 @@ "unique_name", "status" ], - "pathType": "list", "dependentProperties": { "billing_period": "{sim_sid: sid}", "sim_ip_address": "{sim_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Register a Super SIM to your Account", @@ -2788,6 +3725,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "create": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -2800,9 +3756,6 @@ } ], "operationId": "CreateSim", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2823,6 +3776,14 @@ "Iccid", "RegistrationCode" ] + }, + "examples": { + "create": { + "value": { + "Iccid": "89883070000123456789", + "RegistrationCode": "H3LL0W0RLD" + } + } } } } @@ -2838,6 +3799,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sim_enum_status" + }, + "examples": { + "readEmpty": { + "value": "new" + }, + "readFullByFleetSid": { + "value": "new" + }, + "readFullByFleetName": { + "value": "new" + } } }, { @@ -2846,6 +3818,17 @@ "description": "The SID or unique name of the Fleet to which a list of Sims are assigned.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFullByFleetSid": { + "value": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFullByFleetName": { + "value": "MyFleet" + } } }, { @@ -2854,6 +3837,11 @@ "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.", "schema": { "type": "string" + }, + "examples": { + "readByIccid": { + "value": "89883070000123456789" + } } }, { @@ -2899,16 +3887,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2917,19 +3907,123 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFullByFleetSid": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "sims": [ + { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + ] + } + }, + "readFullByFleetName": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0" + }, + "sims": [ + { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + ] + } + }, + "readByIccid": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0" + }, + "sims": [ + { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + ] + } } } } @@ -2942,10 +4036,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSim", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSim" } }, "/v1/Sims/{Sid}": { @@ -2961,11 +4052,11 @@ "unique_name", "status" ], - "pathType": "instance", "dependentProperties": { "billing_period": "{sim_sid: sid}", "sim_ip_address": "{sim_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Super SIM instance from your account.", @@ -2986,6 +4077,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "fetch": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "My SIM", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -2997,10 +4107,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSim", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSim" }, "post": { "description": "Updates the given properties of a Super SIM instance from your account.", @@ -3021,6 +4128,76 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "updateUniqueName": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "MySIM", + "status": "new", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + }, + "updateFleetWithSid": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": null, + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + }, + "updateFleetWithUniqueName": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": null, + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + }, + "transferSimToAnotherAccount": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "unique_name": null, + "status": "new", + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -3031,6 +4208,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sim" + }, + "examples": { + "updateStatus": { + "value": { + "sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": null, + "status": "scheduled", + "fleet_sid": null, + "iccid": "89883070000123456789", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "billing_periods": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods", + "sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses" + } + } + } } } }, @@ -3043,9 +4239,6 @@ } ], "operationId": "UpdateSim", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3089,6 +4282,40 @@ "description": "The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new." } } + }, + "examples": { + "updateUniqueName": { + "value": { + "UniqueName": "MySIM" + } + }, + "updateStatus": { + "value": { + "Status": "active", + "CallbackUrl": "http://127.0.0.1:9876/path", + "CallbackMethod": "POST" + } + }, + "updateFleetWithSid": { + "value": { + "Fleet": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CallbackUrl": "http://127.0.0.1:9876/path", + "CallbackMethod": "POST" + } + }, + "updateFleetWithUniqueName": { + "value": { + "Fleet": "My Fleet", + "CallbackUrl": "http://127.0.0.1:9876/path", + "CallbackMethod": "POST" + } + }, + "transferSimToAnotherAccount": { + "value": { + "AccountSid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "Fleet": "My Fleet" + } + } } } } @@ -3107,9 +4334,9 @@ "ip_address", "ip_address_version" ], - "pathType": "list", "parent": "/Sims/{Sid}", - "mountName": "sim_ip_addresses" + "mountName": "sim_ip_addresses", + "pathType": "list" }, "get": { "description": "Retrieve a list of IP Addresses for the given Super SIM.", @@ -3166,16 +4393,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3184,18 +4413,51 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "key": "ip_addresses", + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0" + }, + "ip_addresses": [] + } + }, + "readNonEmpty": { + "value": { + "meta": { + "key": "ip_addresses", + "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0" + }, + "ip_addresses": [ + { + "ip_address": "8.8.8.8", + "ip_address_version": "IPv4" + } + ] } } } @@ -3209,10 +4471,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSimIpAddress", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSimIpAddress" } }, "/v1/SmsCommands": { @@ -3238,6 +4497,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sms_command" + }, + "examples": { + "createCommandMinimal": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "checkin: firmware update", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "direction": "to_sim", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCommandFull": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "Report location: (52.520008, 13.404954)", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "direction": "to_sim", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3250,9 +4537,6 @@ } ], "operationId": "CreateSmsCommand", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3291,6 +4575,22 @@ "Sim", "Payload" ] + }, + "examples": { + "createCommandMinimal": { + "value": { + "Payload": "checkin: firmware update", + "Sim": "SimSidOrUniqueName" + } + }, + "createCommandFull": { + "value": { + "Payload": "Report location: (52.520008, 13.404954)", + "Sim": "SimSidOrUniqueName", + "CallbackMethod": "POST", + "CallbackUrl": "http://blahblah.com/go" + } + } } } } @@ -3305,6 +4605,14 @@ "description": "The SID or unique name of the Sim resource that SMS Command was sent to or from.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3314,6 +4622,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sms_command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "received" + }, + "readFull": { + "value": "received" + } } }, { @@ -3368,16 +4684,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3386,19 +4704,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sms_commands": [], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sms_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "sms_commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "sms_commands": [ + { + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "content of the command", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "received", + "direction": "from_sim", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -3411,10 +4769,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSmsCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSmsCommand" } }, "/v1/SmsCommands/{Sid}": { @@ -3454,6 +4809,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/supersim.v1.sms_command" + }, + "examples": { + "fetch": { + "value": { + "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "payload": "content of the command", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "direction": "to_sim", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3465,10 +4835,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSmsCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSmsCommand" } }, "/v1/UsageRecords": { @@ -3494,6 +4861,11 @@ "description": "SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.", "schema": { "type": "string" + }, + "examples": { + "readDaySimFilter": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3502,6 +4874,11 @@ "description": "SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.", "schema": { "type": "string" + }, + "examples": { + "readDayFleetFilter": { + "value": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3513,6 +4890,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^HW[0-9a-fA-F]{32}$" + }, + "examples": { + "readDayNetworkFilter": { + "value": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3522,6 +4904,14 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readDayCountryFilter": { + "value": "FR" + }, + "readDayGroupBySimAndFilterByCountry": { + "value": "FR" + } } }, { @@ -3531,6 +4921,23 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_group" + }, + "examples": { + "readDayGroupBySim": { + "value": "sim" + }, + "readDayGroupByFleet": { + "value": "fleet" + }, + "readDayGroupByNetwork": { + "value": "network" + }, + "readDayGroupByIsoCountry": { + "value": "isoCountry" + }, + "readDayGroupBySimAndFilterByCountry": { + "value": "sim" + } } }, { @@ -3540,6 +4947,26 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_granularity" + }, + "examples": { + "readAllDay": { + "value": "day" + }, + "readAllHour": { + "value": "hour" + }, + "readDaySimFilter": { + "value": "day" + }, + "readDayNetworkFilter": { + "value": "day" + }, + "readDayCountryFilter": { + "value": "day" + }, + "readDayFleetFilter": { + "value": "day" + } } }, { @@ -3603,16 +5030,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3621,17 +5050,596 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2015-05-01T20:00:00Z", + "end_time": "2015-06-01T20:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0" + } + } + }, + "readAllDay": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0" + } + } + }, + "readAllHour": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-01T01:00:00Z", + "end_time": "2019-05-01T02:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-01T00:00:00Z", + "end_time": "2019-05-01T01:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0" + } + } + }, + "readDaySimFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayNetworkFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayCountryFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayFleetFilter": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-02T00:00:00Z", + "end_time": "2019-05-03T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0" + } + } + }, + "readDayGroupBySim": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0" + } + } + }, + "readDayGroupByFleet": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "network_sid": null, + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": "HFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0" + } + } + }, + "readDayGroupByNetwork": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iso_country": null + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": "HWbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0" + } + } + }, + "readDayGroupByIsoCountry": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": "US" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0" + } + } + }, + "readDayGroupBySimAndFilterByCountry": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + }, + { + "period": { + "start_time": "2019-05-03T00:00:00Z", + "end_time": "2019-05-04T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 150000, + "data_download": 150000, + "data_total": 300000, + "data_total_billed": "0.03", + "billed_unit": "USD", + "sim_sid": "HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "fleet_sid": null, + "network_sid": null, + "iso_country": "FR" + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0" + } + } + }, + "readAllNoBilling": { + "value": { + "usage_records": [ + { + "period": { + "start_time": "2015-05-01T20:00:00Z", + "end_time": "2015-06-01T20:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data_upload": 1000, + "data_download": 1000, + "data_total": 2000, + "data_total_billed": "0", + "billed_unit": null, + "sim_sid": null, + "fleet_sid": null, + "network_sid": null, + "iso_country": null + } + ], + "meta": { + "first_page_url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0" } } } @@ -3646,10 +5654,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "Beta" - ] + "operationId": "ListUsageRecord" } } }, @@ -3657,15 +5662,5 @@ { "url": "https://supersim.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 3991c17a..a914a012 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "sync.v1.service.document": { "type": "object", @@ -736,12 +742,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -757,7 +757,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -774,11 +774,11 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { "document_permission": "{service_sid: service_sid, document_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -808,6 +808,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -819,10 +839,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDocument" }, "delete": { "description": "", @@ -856,10 +873,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteDocument" }, "post": { "description": "", @@ -897,6 +911,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -909,9 +943,6 @@ } ], "operationId": "UpdateDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -927,6 +958,15 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live)." } } + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -946,11 +986,11 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { "document_permission": "{service_sid: service_sid, document_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -971,6 +1011,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + } } } }, @@ -983,9 +1043,6 @@ } ], "operationId": "CreateDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1005,6 +1062,15 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live)." } } + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -1065,16 +1131,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1083,17 +1151,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "documents": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "documents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" } } } @@ -1108,10 +1221,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListDocument" } }, "/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { @@ -1128,9 +1238,9 @@ "write", "manage" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" + "mountName": "document_permissions", + "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Document Permission.", @@ -1169,6 +1279,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -1180,10 +1304,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", @@ -1226,10 +1347,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", @@ -1268,6 +1386,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.document.document_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -1280,9 +1412,6 @@ } ], "operationId": "UpdateDocumentPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1308,6 +1437,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -1328,9 +1466,9 @@ "write", "manage" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" + "mountName": "document_permissions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Document.", @@ -1396,16 +1534,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1414,17 +1554,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -1439,10 +1618,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListDocumentPermission" } }, "/v1/Services/{Sid}": { @@ -1458,13 +1634,13 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "document": "{service_sid: sid}", "sync_list": "{service_sid: sid}", "sync_map": "{service_sid: sid}", "sync_stream": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1485,6 +1661,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": false, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + } } } }, @@ -1496,10 +1697,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -1524,10 +1722,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -1548,6 +1743,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": true, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + } } } }, @@ -1560,9 +1780,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1600,6 +1817,15 @@ "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } } } } @@ -1619,13 +1845,13 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "document": "{service_sid: sid}", "sync_list": "{service_sid: sid}", "sync_map": "{service_sid: sid}", "sync_stream": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -1635,6 +1861,31 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": true, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + } } } }, @@ -1647,9 +1898,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1687,6 +1935,16 @@ "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true, + "ReachabilityDebouncingWindow": 5000 + } + } } } } @@ -1738,16 +1996,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1756,18 +2016,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services?PageSize=50&Page=0" + }, + "services": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps", + "streams": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "webhooks_from_rest_enabled": false, + "reachability_webhooks_enabled": false, + "acl_enabled": false, + "reachability_debouncing_enabled": false, + "reachability_debouncing_window": 5000 + } + ] } } } @@ -1781,10 +2091,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages": { @@ -1793,14 +2100,14 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Streams/{Sid}", - "mountName": "stream_messages" + "mountName": "stream_messages", + "pathType": "list" }, "post": { "description": "Create a new Stream Message.", @@ -1830,6 +2137,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream.stream_message" + }, + "examples": { + "create": { + "value": { + "sid": "TZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {} + } + } } } }, @@ -1842,9 +2157,6 @@ } ], "operationId": "CreateStreamMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1859,6 +2171,13 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } } } } @@ -1878,13 +2197,13 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { "sync_list_item": "{service_sid: service_sid, list_sid: sid}", "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "instance" }, "get": { "description": "", @@ -1914,6 +2233,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1925,10 +2264,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncList" }, "delete": { "description": "", @@ -1962,10 +2298,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncList" }, "post": { "description": "", @@ -1995,6 +2328,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2007,9 +2360,6 @@ } ], "operationId": "UpdateSyncList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2026,6 +2376,13 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600 + } + } } } } @@ -2045,13 +2402,13 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { "sync_list_item": "{service_sid: service_sid, list_sid: sid}", "sync_list_permission": "{service_sid: service_sid, list_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "list" }, "post": { "description": "", @@ -2072,6 +2429,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2084,9 +2461,6 @@ } ], "operationId": "CreateSyncList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2107,6 +2481,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -2167,16 +2549,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2185,17 +2569,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "lists": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } } @@ -2210,10 +2639,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncList" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { @@ -2229,9 +2655,9 @@ "revision", "created_by" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "instance" }, "get": { "description": "", @@ -2270,6 +2696,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -2281,10 +2724,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncListItem" }, "delete": { "description": "", @@ -2335,10 +2775,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncListItem" }, "post": { "description": "", @@ -2385,6 +2822,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -2397,9 +2851,6 @@ } ], "operationId": "UpdateSyncListItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2423,6 +2874,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request." } } + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -2442,9 +2901,9 @@ "revision", "created_by" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "list" }, "post": { "description": "", @@ -2474,6 +2933,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } } } }, @@ -2486,9 +2962,6 @@ } ], "operationId": "CreateSyncListItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2515,6 +2988,14 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -2548,6 +3029,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -2556,6 +3045,14 @@ "description": "The `index` of the first Sync List Item resource to read. See also `bounds`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -2565,6 +3062,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -2610,16 +3115,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2628,17 +3135,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -2653,10 +3202,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncListItem" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { @@ -2673,9 +3219,9 @@ "write", "manage" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions" + "mountName": "sync_list_permissions", + "pathType": "instance" }, "get": { "description": "Fetch a specific Sync List Permission.", @@ -2714,6 +3260,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -2725,10 +3285,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", @@ -2771,10 +3328,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", @@ -2813,6 +3367,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -2825,9 +3393,6 @@ } ], "operationId": "UpdateSyncListPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2853,6 +3418,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -2873,9 +3447,9 @@ "write", "manage" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions" + "mountName": "sync_list_permissions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync List.", @@ -2941,16 +3515,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2959,17 +3535,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -2984,10 +3599,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncListPermission" } }, "/v1/Services/{ServiceSid}/Maps/{Sid}": { @@ -3003,13 +3615,13 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { "sync_map_item": "{service_sid: service_sid, map_sid: sid}", "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "instance" }, "get": { "description": "", @@ -3039,6 +3651,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3050,10 +3682,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMap" }, "delete": { "description": "", @@ -3087,10 +3716,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMap" }, "post": { "description": "", @@ -3120,6 +3746,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3132,9 +3778,6 @@ } ], "operationId": "UpdateSyncMap", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3151,6 +3794,13 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600 + } + } } } } @@ -3170,13 +3820,13 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { "sync_map_item": "{service_sid: service_sid, map_sid: sid}", "sync_map_permission": "{service_sid: service_sid, map_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "list" }, "post": { "description": "", @@ -3197,6 +3847,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3209,9 +3879,6 @@ } ], "operationId": "CreateSyncMap", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3232,6 +3899,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -3292,16 +3967,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3310,17 +3987,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "maps": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "maps": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } @@ -3335,10 +4057,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMap" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { @@ -3354,9 +4073,9 @@ "revision", "created_by" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "instance" }, "get": { "description": "", @@ -3395,6 +4114,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -3406,10 +4142,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMapItem" }, "delete": { "description": "", @@ -3460,10 +4193,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMapItem" }, "post": { "description": "", @@ -3510,6 +4240,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -3522,9 +4269,6 @@ } ], "operationId": "UpdateSyncMapItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3548,6 +4292,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request." } } + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -3567,9 +4319,9 @@ "revision", "created_by" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "list" }, "post": { "description": "", @@ -3599,6 +4351,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + } } } }, @@ -3611,9 +4380,6 @@ } ], "operationId": "CreateSyncMapItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3645,6 +4411,15 @@ "Key", "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key", + "Ttl": 3600 + } + } } } } @@ -3678,6 +4453,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -3686,6 +4469,14 @@ "description": "The `key` of the first Sync Map Item resource to read. See also `bounds`.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -3695,6 +4486,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -3740,16 +4539,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3758,17 +4559,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" } } } @@ -3783,10 +4626,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMapItem" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { @@ -3795,7 +4635,7 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", @@ -3803,9 +4643,9 @@ "write", "manage" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "mountName": "sync_map_permissions", + "pathType": "instance" }, "get": { "description": "Fetch a specific Sync Map Permission.", @@ -3844,6 +4684,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -3855,10 +4709,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", @@ -3901,10 +4752,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", @@ -3943,6 +4791,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } } } }, @@ -3955,9 +4817,6 @@ } ], "operationId": "UpdateSyncMapPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3983,6 +4842,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -3995,7 +4863,7 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", @@ -4003,9 +4871,9 @@ "write", "manage" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "mountName": "sync_map_permissions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Permissions applying to a Sync Map.", @@ -4071,16 +4939,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4089,17 +4959,56 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "permissions": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -4114,10 +5023,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMapPermission" } }, "/v1/Services/{ServiceSid}/Streams/{Sid}": { @@ -4126,19 +5032,19 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], - "pathType": "instance", "dependentProperties": { "stream_message": "{service_sid: service_sid, stream_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_streams" + "mountName": "sync_streams", + "pathType": "instance" }, "get": { "description": "Fetch a specific Stream.", @@ -4168,6 +5074,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4179,10 +5103,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncStream" }, "delete": { "description": "Delete a specific Stream.", @@ -4216,10 +5137,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncStream" }, "post": { "description": "Update a specific Stream.", @@ -4249,6 +5167,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4261,9 +5197,6 @@ } ], "operationId": "UpdateSyncStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4276,6 +5209,13 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live)." } } + }, + "examples": { + "update": { + "value": { + "Ttl": 3600 + } + } } } } @@ -4288,19 +5228,19 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], - "pathType": "list", "dependentProperties": { "stream_message": "{service_sid: service_sid, stream_sid: sid}" }, "parent": "/Services/{Sid}", - "mountName": "sync_streams" + "mountName": "sync_streams", + "pathType": "list" }, "post": { "description": "Create a new Stream.", @@ -4321,6 +5261,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4333,9 +5291,6 @@ } ], "operationId": "CreateSyncStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4352,6 +5307,14 @@ "description": "How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live)." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "Ttl": 3600 + } + } } } } @@ -4412,16 +5375,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4430,17 +5395,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "streams": [], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0", + "key": "streams", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "streams": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_expires": "2015-07-30T21:00:00Z", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages" + }, + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0", + "key": "streams", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0" } } } @@ -4455,10 +5463,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncStream" } } }, @@ -4466,11 +5471,5 @@ { "url": "https://sync.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index fd4d74cc..40bc3a2b 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "taskrouter.v1.workspace.activity": { "type": "object", @@ -492,6 +498,42 @@ "LIFO" ] }, + "taskrouter.v1.task_queue_bulk_real_time_statistics": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource." + }, + "workspace_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Workspace that contains the TaskQueue." + }, + "task_queue_data": { + "nullable": true, + "description": "The TaskQueue RealTime Statistics for each requested TaskQueue SID, represented as a map of TaskQueue SID to the TaskQueue result, each result contains the following attributes: task_queue_sid: The SID of the TaskQueue from which these statistics were calculated, total_available_workers: The total number of Workers available for Tasks in the TaskQueue, total_eligible_workers: The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state, total_tasks: The total number of Tasks, longest_task_waiting_age: The age of the longest waiting Task, longest_task_waiting_sid: The SID of the longest waiting Task, tasks_by_status: The number of Tasks by their current status, tasks_by_priority: The number of Tasks by priority, activity_statistics: The number of current Workers by Activity." + }, + "task_queue_response_count": { + "type": "integer", + "nullable": true, + "description": "The number of TaskQueue statistics received in task_queue_data." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the TaskQueue statistics resource." + } + } + }, "taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics": { "type": "object", "properties": { @@ -2016,12 +2058,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2037,7 +2073,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -2047,15 +2083,15 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2091,6 +2127,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -2102,10 +2155,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchActivity", - "x-maturity": [ - "GA" - ] + "operationId": "FetchActivity" }, "post": { "description": "", @@ -2141,6 +2191,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -2153,9 +2220,6 @@ } ], "operationId": "UpdateActivity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2168,6 +2232,13 @@ "description": "A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -2211,10 +2282,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteActivity", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteActivity" } }, "/v1/Workspaces/{WorkspaceSid}/Activities": { @@ -2223,15 +2291,15 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2254,6 +2322,14 @@ "description": "The `friendly_name` of the Activity resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -2262,6 +2338,14 @@ "description": "Whether return only Activity resources that are available or unavailable. A value of `true` returns only available activities. Values of '1' or `yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "true" + }, + "readEmpty": { + "value": "true" + } } }, { @@ -2307,16 +2391,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2325,17 +2411,59 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "activities": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "activities", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "activities": [], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "activities", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0" } } } @@ -2350,10 +2478,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListActivity", - "x-maturity": [ - "GA" - ] + "operationId": "ListActivity" }, "post": { "description": "", @@ -2377,6 +2502,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available": true, + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "friendly_name": "New Activity", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -2389,9 +2531,6 @@ } ], "operationId": "CreateActivity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2411,6 +2550,14 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "Available": "true", + "FriendlyName": "friendly_name" + } + } } } } @@ -2423,15 +2570,15 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "description", "event_date" ], - "pathType": "instance", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2467,6 +2614,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.event" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "workspace", + "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Worker JustinWorker updated to Idle Activity", + "event_data": { + "worker_activity_name": "Offline", + "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_attributes": "{}", + "worker_name": "JustinWorker", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_time_in_previous_activity": "26", + "worker_time_in_previous_activity_ms": "26123", + "workspace_name": "WorkspaceName", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "event_date": "2015-02-07T00:32:41Z", + "event_date_ms": 987654321111, + "event_type": "worker.activity", + "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "worker", + "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "twilio", + "source_ip_address": "1.2.3.4", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2478,10 +2658,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvent" } }, "/v1/Workspaces/{WorkspaceSid}/Events": { @@ -2490,15 +2667,15 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "description", "event_date" ], - "pathType": "list", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2522,6 +2699,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-03T00:00:00Z" + } } }, { @@ -2530,6 +2715,14 @@ "description": "The type of Events to read. Returns only Events of the type specified.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "reservation.created" + }, + "readEmpty": { + "value": "reservation.created" + } } }, { @@ -2549,6 +2742,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2558,6 +2759,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -2569,6 +2778,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2580,6 +2797,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2591,6 +2816,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2602,6 +2835,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2666,16 +2907,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2684,17 +2927,75 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "events": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "actor_type": "workspace", + "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Worker JustinWorker updated to Idle Activity", + "event_data": { + "worker_activity_name": "Offline", + "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_attributes": "{}", + "worker_name": "JustinWorker", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_time_in_previous_activity": "26", + "worker_time_in_previous_activity_ms": "26123", + "workspace_name": "WorkspaceName", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "event_date": "2015-02-07T00:32:41Z", + "event_date_ms": 987654321111, + "event_type": "worker.activity", + "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resource_type": "worker", + "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "twilio", + "source_ip_address": "1.2.3.4", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "events": [], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "events", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } } @@ -2709,10 +3010,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvent" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}": { @@ -2721,7 +3019,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2730,11 +3028,11 @@ "priority", "reason" ], - "pathType": "instance", "dependentProperties": { "reservation": "{workspace_sid: workspace_sid, task_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2770,6 +3068,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "age": 25200, + "assignment_status": "pending", + "attributes": "{\"body\": \"hello\"}", + "date_created": "2014-05-14T18:50:02Z", + "date_updated": "2014-05-15T07:26:06Z", + "task_queue_entered_date": "2014-05-14T18:50:02Z", + "priority": 0, + "reason": "Test Reason", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "task-channel", + "timeout": 60, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_friendly_name": "Test Workflow", + "task_queue_friendly_name": "Test Queue", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -2781,10 +3111,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTask", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTask" }, "post": { "description": "", @@ -2828,6 +3155,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "age": 25200, + "assignment_status": "pending", + "attributes": "{\"body\": \"hello\"}", + "date_created": "2014-05-14T18:50:02Z", + "date_updated": "2014-05-15T07:26:06Z", + "task_queue_entered_date": "2014-05-14T18:50:02Z", + "priority": 0, + "reason": "Test Reason", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "task-channel", + "timeout": 60, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_friendly_name": "Test Workflow", + "task_queue_friendly_name": "Test Queue", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -2840,9 +3199,6 @@ } ], "operationId": "UpdateTask", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2872,6 +3228,16 @@ "description": "When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`." } } + }, + "examples": { + "update": { + "value": { + "AssignmentStatus": "pending", + "Attributes": "attributes", + "Priority": 1, + "Reason": "reason" + } + } } } } @@ -2923,10 +3289,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTask", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTask" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks": { @@ -2935,7 +3298,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2944,11 +3307,11 @@ "priority", "reason" ], - "pathType": "list", "dependentProperties": { "reservation": "{workspace_sid: workspace_sid, task_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2971,6 +3334,17 @@ "description": "The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + }, + "readAssignmentStatusMultiple": { + "value": 1 + } } }, { @@ -2982,6 +3356,20 @@ "items": { "type": "string" } + }, + "examples": { + "readFull": { + "value": "pending,reserved" + }, + "readEmpty": { + "value": "pending" + }, + "readAssignmentStatusMultiple": { + "value": [ + "pending", + "reserved" + ] + } } }, { @@ -2993,6 +3381,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3001,6 +3400,17 @@ "description": "The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "workflow_name" + }, + "readEmpty": { + "value": "workflow_name" + }, + "readAssignmentStatusMultiple": { + "value": "workflow_name" + } } }, { @@ -3012,6 +3422,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3020,6 +3441,17 @@ "description": "The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "task_queue_name" + }, + "readEmpty": { + "value": "task_queue_name" + }, + "readAssignmentStatusMultiple": { + "value": "task_queue_name" + } } }, { @@ -3089,16 +3521,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3107,18 +3541,89 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0", + "key": "tasks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0" + }, + "tasks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "age": 25200, + "assignment_status": "pending", + "attributes": "{\"body\": \"hello\"}", + "date_created": "2014-05-14T14:26:54Z", + "date_updated": "2014-05-15T16:03:42Z", + "task_queue_entered_date": "2014-05-14T14:26:54Z", + "priority": 0, + "reason": "Test Reason", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "task-channel", + "timeout": 60, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_friendly_name": "Test Workflow", + "task_queue_friendly_name": "Test Queue", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0", + "key": "tasks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0" + }, + "tasks": [] + } + }, + "readAssignmentStatusMultiple": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0", + "key": "tasks", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0" + }, + "tasks": [] } } } @@ -3132,10 +3637,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTask", - "x-maturity": [ - "GA" - ] + "operationId": "ListTask" }, "post": { "description": "", @@ -3159,6 +3661,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "age": 25200, + "assignment_status": "pending", + "attributes": "{\"body\": \"attributes\"}", + "date_created": "2014-05-14T18:50:02Z", + "date_updated": "2014-05-15T07:26:06Z", + "task_queue_entered_date": null, + "priority": 1, + "reason": "Test Reason", + "sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "unique", + "timeout": 60, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow_friendly_name": "Example Workflow", + "task_queue_friendly_name": "Example Task Queue", + "addons": "{}", + "links": { + "task_queue": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workflow": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -3171,9 +3705,6 @@ } ], "operationId": "CreateTask", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3205,6 +3736,17 @@ "description": "A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \"task_type\": \"call\", \"twilio_call_sid\": \"CAxxx\", \"customer_ticket_number\": \"12345\" }`." } } + }, + "examples": { + "create": { + "value": { + "Attributes": "{\"body\": \"attributes\"}", + "Priority": 1, + "Timeout": 1, + "WorkflowSid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskChannel": "channel" + } + } } } } @@ -3224,8 +3766,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3258,6 +3800,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" + }, + "examples": { + "fetchSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "friendly_name": "Default", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "fetchUniqueName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "friendly_name": "Default", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": false, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -3269,10 +3845,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskChannel" }, "post": { "description": "", @@ -3305,6 +3878,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" + }, + "examples": { + "updateSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Default", + "unique_name": "default", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "updateUniqueName": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Default", + "unique_name": "default", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -3317,9 +3924,6 @@ } ], "operationId": "UpdateTaskChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3336,6 +3940,20 @@ "description": "Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized." } } + }, + "examples": { + "updateSid": { + "value": { + "FriendlyName": "Outbound Voice", + "ChannelOptimizedRouting": true + } + }, + "updateUniqueName": { + "value": { + "FriendlyName": "Outbound Voice", + "ChannelOptimizedRouting": true + } + } } } } @@ -3376,10 +3994,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTaskChannel" } }, "/v1/Workspaces/{WorkspaceSid}/TaskChannels": { @@ -3395,8 +4010,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3456,16 +4071,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3474,17 +4091,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "friendly_name": "Default", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_optimized_routing": true, + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "channels": [], + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0" } } } @@ -3499,10 +4159,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskChannel" }, "post": { "description": "", @@ -3526,6 +4183,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Outbound Voice", + "unique_name": "ovoice", + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "channel_optimized_routing": true, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } } } }, @@ -3538,9 +4213,6 @@ } ], "operationId": "CreateTaskChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3565,6 +4237,14 @@ "FriendlyName", "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Outbound Voice", + "UniqueName": "ovoice" + } + } } } } @@ -3577,20 +4257,20 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "task_order" ], - "pathType": "instance", "dependentProperties": { "task_queue_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", "task_queue_real_time_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", "task_queue_cumulative_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3626,6 +4306,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_activity_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "assignment_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-08-04T01:31:41Z", + "date_updated": "2015-08-04T01:31:41Z", + "friendly_name": "81f96435-3a05-11e5-9f81-98e0d9a1eb73", + "max_reserved_workers": 1, + "links": { + "assignment_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + }, + "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_workers": null, + "task_order": "FIFO", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3637,10 +4347,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueue" }, "post": { "description": "", @@ -3676,6 +4383,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_activity_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "assignment_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-08-04T01:31:41Z", + "date_updated": "2015-08-04T01:31:41Z", + "friendly_name": "81f96435-3a05-11e5-9f81-98e0d9a1eb73", + "max_reserved_workers": 1, + "links": { + "assignment_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + }, + "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_workers": null, + "task_order": "FIFO", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3688,9 +4425,6 @@ } ], "operationId": "UpdateTaskQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3730,6 +4464,18 @@ "description": "How Tasks will be assigned to Workers. Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)." } } + }, + "examples": { + "update": { + "value": { + "AssignmentActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "MaxReservedWorkers": 1, + "ReservationActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TargetWorkers": "target_workers", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3773,10 +4519,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTaskQueue" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues": { @@ -3785,20 +4528,20 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "task_order" ], - "pathType": "list", "dependentProperties": { "task_queue_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", "task_queue_real_time_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}", "task_queue_cumulative_statistics": "{workspace_sid: workspace_sid, task_queue_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3821,6 +4564,14 @@ "description": "The `friendly_name` of the TaskQueue resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -3829,6 +4580,14 @@ "description": "The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "evaluate_worker_attributes" + }, + "readEmpty": { + "value": "evaluate_worker_attributes" + } } }, { @@ -3893,16 +4652,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3911,22 +4672,77 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } } - } - } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "task_queues", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "task_queues": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_activity_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "assignment_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-08-04T01:31:41Z", + "date_updated": "2015-08-04T01:31:41Z", + "friendly_name": "81f96435-3a05-11e5-9f81-98e0d9a1eb73", + "max_reserved_workers": 1, + "links": { + "assignment_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + }, + "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_workers": null, + "task_order": "FIFO", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "task_queues", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "task_queues": [] + } + } + } + } }, "description": "OK" } @@ -3936,10 +4752,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskQueue" }, "post": { "description": "", @@ -3963,6 +4776,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_activity_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "assignment_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-08-04T01:31:41Z", + "date_updated": "2015-08-04T01:31:41Z", + "friendly_name": "81f96435-3a05-11e5-9f81-98e0d9a1eb73", + "max_reserved_workers": 1, + "links": { + "assignment_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + }, + "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "target_workers": null, + "task_order": "FIFO", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3975,9 +4818,6 @@ } ], "operationId": "CreateTaskQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4020,19 +4860,132 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "AssignmentActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "MaxReservedWorkers": 1, + "ReservationActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TargetWorkers": "target_workers", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } } } }, + "/v1/Workspaces/{WorkspaceSid}/TaskQueues/RealTimeStatistics": { + "servers": [ + { + "url": "https://taskrouter.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "workspace_sid" + ], + "mountName": "bulk_real_time_statistics", + "className": "task_queue_bulk_real_time_statistics", + "pathType": "list" + }, + "post": { + "description": "Fetch a Task Queue Real Time Statistics in bulk for the array of TaskQueue SIDs, support upto 50 in a request.", + "parameters": [ + { + "name": "WorkspaceSid", + "in": "path", + "description": "The unique SID identifier of the Workspace.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.task_queue_bulk_real_time_statistics" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics", + "task_queue_data": { + "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa": { + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_tasks": 100, + "total_eligible_workers": 100, + "total_available_workers": 100, + "tasks_by_status": { + "reserved": 0, + "pending": 0, + "assigned": 0, + "wrapping": 0 + }, + "tasks_by_priority": {}, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "task_queue_response_count": 100 + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateTaskQueueBulkRealTimeStatistics" + } + }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics": { "servers": [ { "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -4040,9 +4993,9 @@ "avg_task_acceptance_time", "tasks_completed" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}", - "className": "task_queue_cumulative_statistics" + "className": "task_queue_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -4078,6 +5031,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -4095,6 +5053,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -4120,6 +5083,70 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "reservations_created": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_rejected": 100, + "tasks_completed": 100, + "end_time": "2015-07-30T20:00:00Z", + "tasks_entered": 100, + "tasks_canceled": 100, + "reservations_accepted": 100, + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_timed_out": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "wait_duration_until_canceled": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_in_queue_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "split_by_wait_time": { + "5": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + }, + "10": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + } + }, + "start_time": "2015-07-30T20:00:00Z", + "tasks_moved": 100, + "reservations_canceled": 100, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_deleted": 100, + "reservations_rescinded": 100, + "avg_task_acceptance_time": 100 + } + } } } }, @@ -4131,10 +5158,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics": { @@ -4143,16 +5167,16 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "longest_task_waiting_age", "longest_task_waiting_sid", "total_tasks" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}", - "className": "task_queue_real_time_statistics" + "className": "task_queue_real_time_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -4187,6 +5211,11 @@ "description": "The TaskChannel for which to fetch statistics. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -4196,6 +5225,52 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "longest_relative_task_age_in_queue": 100, + "longest_relative_task_sid_in_queue": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "reserved": 0, + "pending": 0, + "assigned": 0, + "wrapping": 0 + }, + "total_eligible_workers": 100, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "tasks_by_priority": {}, + "total_tasks": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_available_workers": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics" + } + } } } }, @@ -4207,10 +5282,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics": { @@ -4219,14 +5291,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "cumulative" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}", - "className": "task_queue_statistics" + "className": "task_queue_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -4262,6 +5334,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4270,6 +5347,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -4279,6 +5361,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4304,6 +5391,76 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "end_time": "2015-08-18T08:42:34Z", + "reservations_accepted": 0, + "reservations_canceled": 0, + "reservations_created": 0, + "reservations_rejected": 0, + "reservations_rescinded": 0, + "reservations_timed_out": 0, + "start_time": "2015-08-18T08:27:34Z", + "tasks_canceled": 0, + "tasks_deleted": 0, + "tasks_entered": 0, + "tasks_moved": 0 + }, + "realtime": { + "activity_statistics": [ + { + "friendly_name": "Offline", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Idle", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Reserved", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Busy", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + } + ], + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 0, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_available_workers": 0, + "total_eligible_workers": 0, + "total_tasks": 0 + }, + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4315,10 +5472,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics": { @@ -4327,14 +5481,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "cumulative" ], - "pathType": "list", "parent": "/Workspaces/{WorkspaceSid}/TaskQueues", - "className": "task_queues_statistics" + "className": "task_queues_statistics", + "pathType": "list" }, "get": { "description": "", @@ -4358,6 +5512,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4366,6 +5528,14 @@ "description": "The `friendly_name` of the TaskQueue statistics to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -4374,6 +5544,14 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "schema": { "type": "integer" + }, + "examples": { + "readFull": { + "value": 1 + }, + "readEmpty": { + "value": 1 + } } }, { @@ -4383,6 +5561,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4444,16 +5630,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4462,18 +5650,112 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0", + "key": "task_queues_statistics", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0" + }, + "task_queues_statistics": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "end_time": "2015-08-18T08:46:15Z", + "reservations_accepted": 0, + "reservations_canceled": 0, + "reservations_created": 0, + "reservations_rejected": 0, + "reservations_rescinded": 0, + "reservations_timed_out": 0, + "start_time": "2015-08-18T08:31:15Z", + "tasks_canceled": 0, + "tasks_deleted": 0, + "tasks_entered": 0, + "tasks_moved": 0 + }, + "realtime": { + "activity_statistics": [ + { + "friendly_name": "Offline", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Idle", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Reserved", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Busy", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + } + ], + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 0, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_available_workers": 0, + "total_eligible_workers": 0, + "total_tasks": 0 + }, + "task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0", + "key": "task_queues_statistics", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0" + }, + "task_queues_statistics": [] } } } @@ -4487,10 +5769,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskQueuesStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskQueuesStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations": { @@ -4507,8 +5786,8 @@ "worker_name", "worker_sid" ], - "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -4600,16 +5879,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4618,18 +5899,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [] } } } @@ -4643,10 +5970,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskReservation", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskReservation" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}": { @@ -4663,8 +5987,8 @@ "worker_name", "worker_sid" ], - "pathType": "instance", - "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4712,6 +6036,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4723,10 +6068,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskReservation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskReservation" }, "post": { "description": "", @@ -4782,6 +6124,46 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateSuperviseInstruction": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4794,9 +6176,6 @@ } ], "operationId": "UpdateTaskReservation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5096,6 +6475,20 @@ "description": "Whether to play a notification beep when the customer joins." } } + }, + "examples": { + "update": { + "value": { + "ReservationStatus": "accepted" + } + }, + "updateSuperviseInstruction": { + "value": { + "Instruction": "supervise", + "SupervisorMode": "monitor", + "Supervisor": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -5108,14 +6501,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "available" ], - "pathType": "list", "dependentProperties": { "workers_real_time_statistics": "{workspace_sid: workspace_sid}", "workers_cumulative_statistics": "{workspace_sid: workspace_sid}", @@ -5123,7 +6515,8 @@ "reservation": "{workspace_sid: workspace_sid, worker_sid: sid}", "worker_channel": "{workspace_sid: workspace_sid, worker_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -5146,6 +6539,14 @@ "description": "The `activity_name` of the Worker resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "activity_name" + }, + "readEmpty": { + "value": "activity_name" + } } }, { @@ -5157,6 +6558,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -5165,6 +6574,14 @@ "description": "Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "available" + }, + "readEmpty": { + "value": "available" + } } }, { @@ -5173,14 +6590,30 @@ "description": "The `friendly_name` of the Worker resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { "name": "TargetWorkersExpression", "in": "query", - "description": "Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.", + "description": "Filter by Workers that would match an expression. In addition to fields in the workers' attributes, the expression can include the following worker fields: `sid`, `friendly_name`, `activity_sid`, or `activity_name`", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "target_workers_expression" + }, + "readEmpty": { + "value": "target_workers_expression" + } } }, { @@ -5189,6 +6622,14 @@ "description": "The `friendly_name` of the TaskQueue that the Workers to read are eligible for.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "task_queue_name" + }, + "readEmpty": { + "value": "task_queue_name" + } } }, { @@ -5200,6 +6641,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -5253,16 +6702,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5271,18 +6722,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0", + "next_page_url": null, + "key": "workers" + }, + "workers": [ + { + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "testWorker", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "Offline", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:05:29Z", + "date_updated": "2017-05-30T23:05:29Z", + "date_status_changed": "2017-05-30T23:05:29Z", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workers", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workers": [] } } } @@ -5296,10 +6802,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorker", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorker" }, "post": { "description": "", @@ -5323,6 +6826,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "examples": { + "create": { + "value": { + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "NewWorker", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "Offline", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:19:38Z", + "date_updated": "2017-05-30T23:19:38Z", + "date_status_changed": "2017-05-30T23:19:38Z", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -5335,9 +6868,6 @@ } ], "operationId": "CreateWorker", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5364,6 +6894,16 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "ActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "attributes", + "FriendlyName": "friendly_name", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -5376,14 +6916,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "available" ], - "pathType": "instance", "dependentProperties": { "workers_real_time_statistics": "{workspace_sid: workspace_sid}", "workers_cumulative_statistics": "{workspace_sid: workspace_sid}", @@ -5391,7 +6930,8 @@ "reservation": "{workspace_sid: workspace_sid, worker_sid: sid}", "worker_channel": "{workspace_sid: workspace_sid, worker_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -5427,6 +6967,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "available", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:32:39Z", + "date_status_changed": "2017-05-30T23:32:39Z", + "date_updated": "2017-05-30T23:32:39Z", + "friendly_name": "NewWorker3", + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -5438,10 +7008,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorker", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorker" }, "post": { "description": "", @@ -5485,6 +7052,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "examples": { + "update": { + "value": { + "sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "blah", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "activity_name": "Offline", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": "{}", + "available": false, + "date_created": "2017-05-30T23:32:22Z", + "date_updated": "2017-05-31T00:05:57Z", + "date_status_changed": "2017-05-30T23:32:22Z", + "operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "activity": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "worker_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "worker_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", + "reservations": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations" + } + } + } } } }, @@ -5497,9 +7094,6 @@ } ], "operationId": "UpdateWorker", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5527,6 +7121,16 @@ "description": "Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`." } } + }, + "examples": { + "update": { + "value": { + "ActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "attributes", + "FriendlyName": "friendly_name", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -5578,10 +7182,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorker", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorker" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels": { @@ -5590,16 +7191,16 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "task_channel_sid", "task_channel_unique_name" ], - "pathType": "list", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "mountName": "worker_channels" + "mountName": "worker_channels", + "pathType": "list" }, "get": { "description": "", @@ -5671,16 +7272,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5689,18 +7292,62 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0" + }, + "channels": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_tasks": 0, + "available": true, + "available_capacity_percentage": 100, + "configured_capacity": 1, + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "sid": "WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", + "key": "channels", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0" + }, + "channels": [] } } } @@ -5714,10 +7361,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkerChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkerChannel" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}": { @@ -5726,16 +7370,16 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "task_channel_sid", "task_channel_unique_name" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "mountName": "worker_channels" + "mountName": "worker_channels", + "pathType": "instance" }, "get": { "description": "", @@ -5780,6 +7424,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" + }, + "examples": { + "fetchSid": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_tasks": 0, + "available": true, + "available_capacity_percentage": 100, + "configured_capacity": 1, + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "sid": "WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5791,10 +7454,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerChannel" }, "post": { "description": "", @@ -5839,6 +7499,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assigned_tasks": 0, + "available": true, + "available_capacity_percentage": 100, + "configured_capacity": 3, + "date_created": "2016-04-14T17:35:54Z", + "date_updated": "2016-04-14T17:35:54Z", + "sid": "WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_channel_unique_name": "default", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5851,9 +7530,6 @@ } ], "operationId": "UpdateWorkerChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5870,6 +7546,13 @@ "description": "Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type." } } + }, + "examples": { + "update": { + "value": { + "Capacity": 3 + } + } } } } @@ -5882,14 +7565,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "cumulative" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "className": "worker_statistics" + "className": "worker_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -5924,6 +7607,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -5933,6 +7621,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5942,6 +7635,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5959,6 +7657,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_instance_statistics" + }, + "examples": { + "fetch": { + "value": { + "cumulative": { + "reservations_created": 100, + "reservations_accepted": 100, + "reservations_rejected": 100, + "reservations_timed_out": 100, + "reservations_canceled": 100, + "reservations_rescinded": 100, + "activity_durations": [ + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Offline", + "avg": 1080, + "total": 5400 + }, + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Busy", + "avg": 1012, + "total": 8100 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Idle", + "avg": 0, + "total": 0 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Reserved", + "avg": 0, + "total": 0 + } + ], + "start_time": "2008-01-02T00:00:00Z", + "end_time": "2008-01-02T00:00:00Z" + }, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" + } + } } } }, @@ -5970,10 +7722,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerInstanceStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerInstanceStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations": { @@ -5989,8 +7738,8 @@ "reservation_status", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -6071,16 +7820,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6089,18 +7840,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", + "key": "reservations", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" + }, + "reservations": [] } } } @@ -6114,10 +7911,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkerReservation", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkerReservation" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}": { @@ -6133,8 +7927,8 @@ "reservation_status", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -6182,6 +7976,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6193,10 +8008,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerReservation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerReservation" }, "post": { "description": "", @@ -6252,6 +8064,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:03:42Z", + "links": { + "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "reservation_status": "accepted", + "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_name": "Doug", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6264,9 +8097,6 @@ } ], "operationId": "UpdateWorkerReservation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6557,6 +8387,13 @@ "description": "Whether to play a notification beep when the customer joins." } } + }, + "examples": { + "update": { + "value": { + "ReservationStatus": "accepted" + } + } } } } @@ -6569,14 +8406,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "cumulative" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers", - "className": "workers_statistics" + "className": "workers_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -6599,6 +8436,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -6608,6 +8450,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -6617,6 +8464,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -6661,6 +8513,84 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_statistics" + }, + "examples": { + "fetch": { + "value": { + "cumulative": { + "reservations_created": 0, + "reservations_accepted": 0, + "reservations_rejected": 0, + "reservations_timed_out": 0, + "reservations_canceled": 0, + "reservations_rescinded": 0, + "activity_durations": [ + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Offline", + "avg": 1080, + "total": 5400 + }, + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Busy", + "avg": 1012, + "total": 8100 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Idle", + "avg": 0, + "total": 0 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Reserved", + "avg": 0, + "total": 0 + } + ], + "start_time": "2008-01-02T00:00:00Z", + "end_time": "2008-01-02T00:00:00Z" + }, + "realtime": { + "total_workers": 15, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics" + } + } } } }, @@ -6672,10 +8602,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics": { @@ -6684,7 +8611,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "reservations_created", @@ -6694,9 +8621,9 @@ "reservations_canceled", "reservations_rescinded" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "className": "workers_cumulative_statistics" + "className": "workers_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -6720,6 +8647,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -6737,6 +8669,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -6754,6 +8691,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics", + "reservations_created": 100, + "reservations_accepted": 100, + "reservations_rejected": 100, + "reservations_timed_out": 100, + "reservations_canceled": 100, + "reservations_rescinded": 100, + "activity_durations": [ + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Offline", + "avg": 1080, + "total": 5400 + }, + { + "max": 0, + "min": 900, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Busy", + "avg": 1012, + "total": 8100 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Idle", + "avg": 0, + "total": 0 + }, + { + "max": 0, + "min": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Reserved", + "avg": 0, + "total": 0 + } + ], + "start_time": "2015-07-30T20:00:00Z", + "end_time": "2015-07-30T20:00:00Z" + } + } } } }, @@ -6765,10 +8753,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkersCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkersCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics": { @@ -6777,14 +8762,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "total_workers" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "className": "workers_real_time_statistics" + "className": "workers_real_time_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -6807,6 +8792,11 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -6816,6 +8806,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics", + "total_workers": 15, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } } } }, @@ -6827,10 +8849,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkersRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkersRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}": { @@ -6839,20 +8858,20 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "document_content_type" ], - "pathType": "instance", "dependentProperties": { "workflow_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", "workflow_real_time_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", "workflow_cumulative_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -6888,6 +8907,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + } + } + } } } }, @@ -6899,10 +8941,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflow" }, "post": { "description": "", @@ -6938,6 +8977,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -6950,9 +9012,6 @@ } ], "operationId": "UpdateWorkflow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6987,6 +9046,18 @@ "description": "Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again." } } + }, + "examples": { + "update": { + "value": { + "AssignmentCallbackUrl": "http://example.com", + "Configuration": "configuration", + "FallbackAssignmentCallbackUrl": "http://example.com", + "FriendlyName": "friendly_name", + "TaskReservationTimeout": 1, + "ReEvaluateTasks": "false" + } + } } } } @@ -7030,10 +9101,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorkflow" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows": { @@ -7042,20 +9110,20 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "document_content_type" ], - "pathType": "list", "dependentProperties": { "workflow_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", "workflow_real_time_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}", "workflow_cumulative_statistics": "{workspace_sid: workspace_sid, workflow_sid: sid}" }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -7078,6 +9146,14 @@ "description": "The `friendly_name` of the Workflow resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -7123,16 +9199,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7141,18 +9219,66 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workflows", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workflows": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-15T16:47:51Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workflows", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workflows": [] } } } @@ -7166,10 +9292,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkflow" }, "post": { "description": "", @@ -7193,6 +9316,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "assignment_callback_url": "http://example.com", + "configuration": "task-routing:\\n - filter: \\n - 1 == 1\\n target:\\n - queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\n set-priority: 0\\n", + "date_created": "2014-05-14T10:50:02Z", + "date_updated": "2014-05-14T23:26:06Z", + "document_content_type": "application/json", + "fallback_assignment_callback_url": null, + "friendly_name": "Default Fifo Workflow", + "sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "task_reservation_timeout": 120, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics" + } + } + } } } }, @@ -7205,9 +9351,6 @@ } ], "operationId": "CreateWorkflow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7242,6 +9385,17 @@ "FriendlyName", "Configuration" ] + }, + "examples": { + "create": { + "value": { + "AssignmentCallbackUrl": "http://example.com", + "Configuration": "configuration", + "FallbackAssignmentCallbackUrl": "http://example.com", + "FriendlyName": "friendly_name", + "TaskReservationTimeout": 1 + } + } } } } @@ -7254,7 +9408,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -7262,9 +9416,9 @@ "avg_task_acceptance_time", "tasks_completed" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workflows/{Sid}", - "className": "workflow_cumulative_statistics" + "className": "workflow_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -7300,6 +9454,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7317,6 +9476,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7342,6 +9506,65 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "avg_task_acceptance_time": 100, + "tasks_canceled": 100, + "start_time": "2015-07-30T20:00:00Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_moved": 100, + "tasks_entered": 100, + "wait_duration_until_canceled": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "split_by_wait_time": { + "5": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + }, + "10": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + } + }, + "reservations_canceled": 100, + "end_time": "2015-07-30T20:00:00Z", + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_created": 100, + "reservations_accepted": 100, + "reservations_rescinded": 100, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservations_rejected": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "tasks_deleted": 100, + "tasks_timed_out_in_workflow": 100, + "tasks_completed": 100, + "reservations_timed_out": 100 + } + } } } }, @@ -7353,10 +9576,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics": { @@ -7365,16 +9585,16 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "longest_task_waiting_age", "longest_task_waiting_sid", "total_tasks" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workflows/{Sid}", - "className": "workflow_real_time_statistics" + "className": "workflow_real_time_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -7409,6 +9629,11 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -7418,6 +9643,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "tasks_by_priority": {}, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "reserved": 0, + "pending": 0, + "assigned": 0, + "wrapping": 0 + }, + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_tasks": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7429,10 +9674,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics": { @@ -7441,14 +9683,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "cumulative" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workflows/{Sid}", - "className": "workflow_statistics" + "className": "workflow_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -7483,6 +9725,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -7492,6 +9739,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7501,6 +9753,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7526,6 +9783,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "end_time": "2008-01-02T00:00:00Z", + "reservations_accepted": 0, + "reservations_rejected": 0, + "reservations_timed_out": 0, + "start_time": "2008-01-02T00:00:00Z", + "tasks_canceled": 0, + "tasks_entered": 0, + "tasks_moved": 0, + "tasks_timed_out_in_workflow": 0 + }, + "realtime": { + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 1, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_tasks": 1 + }, + "workflow_sid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7537,10 +9827,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowStatistics" } }, "/v1/Workspaces/{Sid}": { @@ -7549,14 +9836,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "prioritize_queue_order" ], - "pathType": "instance", "dependentProperties": { "activity": "{workspace_sid: sid}", "event": "{workspace_sid: sid}", @@ -7568,7 +9854,8 @@ "workspace_real_time_statistics": "{workspace_sid: sid}", "workspace_cumulative_statistics": "{workspace_sid: sid}", "task_channel": "{workspace_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -7592,6 +9879,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7603,10 +9923,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspace" }, "post": { "description": "", @@ -7630,6 +9947,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7642,9 +9992,6 @@ } ], "operationId": "UpdateWorkspace", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7689,6 +10036,16 @@ "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)." } } + }, + "examples": { + "update": { + "value": { + "DefaultActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EventCallbackUrl": "/example", + "FriendlyName": "friendly_name", + "TimeoutActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -7720,10 +10077,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorkspace" } }, "/v1/Workspaces": { @@ -7732,14 +10086,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "prioritize_queue_order" ], - "pathType": "list", "dependentProperties": { "activity": "{workspace_sid: sid}", "event": "{workspace_sid: sid}", @@ -7751,7 +10104,8 @@ "workspace_real_time_statistics": "{workspace_sid: sid}", "workspace_cumulative_statistics": "{workspace_sid: sid}", "task_channel": "{workspace_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "", @@ -7762,6 +10116,14 @@ "description": "The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election Campaign`.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -7807,16 +10169,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7825,18 +10189,76 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workspaces", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workspaces": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0", + "key": "workspaces", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0" + }, + "workspaces": [] } } } @@ -7850,10 +10272,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkspace" }, "post": { "description": "", @@ -7863,6 +10282,39 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-08-01T22:10:40Z", + "date_updated": "2016-08-01T22:10:40Z", + "default_activity_name": "Offline", + "default_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "event_callback_url": "", + "events_filter": null, + "friendly_name": "new", + "links": { + "activities": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities", + "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "task_queues": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues", + "tasks": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", + "workers": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers", + "workflows": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows", + "task_channels": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels", + "events": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events" + }, + "multi_task_enabled": false, + "prioritize_queue_order": "FIFO", + "sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "timeout_activity_name": "Offline", + "timeout_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_operating_unit_sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -7875,9 +10327,6 @@ } ], "operationId": "CreateWorkspace", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7915,6 +10364,15 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "EventCallbackUrl": "/example", + "FriendlyName": "friendly_name", + "Template": "template" + } + } } } } @@ -7927,7 +10385,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -7935,9 +10393,9 @@ "avg_task_acceptance_time", "tasks_completed" ], - "pathType": "instance", "parent": "/Workspaces/{Sid}", - "className": "workspace_cumulative_statistics" + "className": "workspace_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -7961,6 +10419,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7978,6 +10441,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -8003,6 +10471,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_cumulative_statistics" + }, + "examples": { + "fetch": { + "value": { + "reservations_accepted": 100, + "tasks_completed": 100, + "start_time": "2015-07-30T20:00:00Z", + "reservations_rescinded": 100, + "tasks_timed_out_in_workflow": 100, + "end_time": "2015-07-30T20:00:00Z", + "avg_task_acceptance_time": 100, + "tasks_canceled": 100, + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", + "tasks_moved": 100, + "tasks_deleted": 100, + "tasks_created": 100, + "reservations_canceled": 100, + "reservations_timed_out": 100, + "wait_duration_until_canceled": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "wait_duration_until_accepted": { + "avg": 0, + "min": 0, + "max": 0, + "total": 0 + }, + "split_by_wait_time": { + "5": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + }, + "10": { + "above": { + "tasks_canceled": 0, + "reservations_accepted": 0 + }, + "below": { + "tasks_canceled": 0, + "reservations_accepted": 0 + } + } + }, + "reservations_created": 100, + "reservations_rejected": 100, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8014,10 +10540,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/RealTimeStatistics": { @@ -8026,16 +10549,16 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "longest_task_waiting_age", "longest_task_waiting_sid", "total_tasks" ], - "pathType": "instance", "parent": "/Workspaces/{Sid}", - "className": "workspace_real_time_statistics" + "className": "workspace_real_time_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -8058,6 +10581,11 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "voice" + } } } ], @@ -8067,6 +10595,43 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_real_time_statistics" + }, + "examples": { + "fetch": { + "value": { + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", + "tasks_by_priority": {}, + "activity_statistics": [ + { + "friendly_name": "Idle", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Busy", + "workers": 9, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Offline", + "workers": 6, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "friendly_name": "Reserved", + "workers": 0, + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "longest_task_waiting_age": 100, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "total_workers": 100, + "total_tasks": 100, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": {} + } + } } } }, @@ -8078,10 +10643,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Statistics": { @@ -8090,14 +10652,14 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "cumulative" ], - "pathType": "instance", "parent": "/Workspaces/{Sid}", - "className": "workspace_statistics" + "className": "workspace_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -8120,6 +10682,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -8129,6 +10696,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -8138,6 +10710,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -8163,6 +10740,75 @@ "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_statistics" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", + "cumulative": { + "avg_task_acceptance_time": 0.0, + "start_time": "2008-01-02T00:00:00Z", + "reservations_accepted": 0, + "reservations_canceled": 0, + "reservations_created": 0, + "reservations_rejected": 0, + "reservations_rescinded": 0, + "reservations_timed_out": 0, + "end_time": "2008-01-02T00:00:00Z", + "tasks_canceled": 0, + "tasks_created": 0, + "tasks_deleted": 0, + "tasks_moved": 0, + "tasks_timed_out_in_workflow": 0 + }, + "realtime": { + "activity_statistics": [ + { + "friendly_name": "Offline", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 1 + }, + { + "friendly_name": "Idle", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Reserved", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "Busy", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + }, + { + "friendly_name": "817ca1c5-3a05-11e5-9292-98e0d9a1eb73", + "sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workers": 0 + } + ], + "longest_task_waiting_age": 0, + "longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "tasks_by_status": { + "assigned": 0, + "pending": 0, + "reserved": 0, + "wrapping": 0 + }, + "total_tasks": 0, + "total_workers": 1 + }, + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -8174,10 +10820,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceStatistics" } } }, @@ -8185,11 +10828,5 @@ { "url": "https://taskrouter.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index ac13508f..9438ed19 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "trunking.v1.trunk.credential_list": { "type": "object", @@ -557,12 +563,6 @@ "from-transferor" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -578,7 +578,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -595,10 +595,10 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Trunks/{Sid}", "mountName": "credentials_lists", - "className": "credential_list" + "className": "credential_list", + "pathType": "instance" }, "get": { "description": "", @@ -634,6 +634,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.credential_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-04-28T00:10:23Z", + "date_updated": "2018-04-28T00:10:23Z", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -645,10 +658,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialList" }, "delete": { "description": "", @@ -688,10 +698,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialList" } }, "/v1/Trunks/{TrunkSid}/CredentialLists": { @@ -707,10 +714,10 @@ "friendly_name", "date_created" ], - "pathType": "list", "parent": "/Trunks/{Sid}", "mountName": "credentials_lists", - "className": "credential_list" + "className": "credential_list", + "pathType": "list" }, "post": { "description": "", @@ -734,6 +741,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.credential_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-02T17:29:30Z", + "date_updated": "2018-05-02T17:29:30Z", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -746,9 +766,6 @@ } ], "operationId": "CreateCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -767,6 +784,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -830,16 +854,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -848,17 +874,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "credential_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-04-27T22:02:11Z", + "date_updated": "2018-04-27T22:02:11Z", + "friendly_name": "friendly_name", + "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "next_page_url": null, + "key": "credential_lists" + } + } + }, + "readEmpty": { + "value": { + "credential_lists": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0", + "next_page_url": null, + "key": "credential_lists" } } } @@ -873,10 +937,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialList" } }, "/v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}": { @@ -892,8 +953,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -929,6 +990,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.ip_access_control_list" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-02T17:29:34Z", + "date_updated": "2018-05-02T17:29:34Z", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -940,10 +1014,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIpAccessControlList" }, "delete": { "description": "Remove an associated IP Access Control List from a Trunk", @@ -983,10 +1054,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIpAccessControlList" } }, "/v1/Trunks/{TrunkSid}/IpAccessControlLists": { @@ -1002,8 +1070,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "Associate an IP Access Control List with a Trunk", @@ -1027,6 +1095,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.ip_access_control_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-04-30T20:59:06Z", + "date_updated": "2018-04-30T20:59:06Z", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1039,9 +1120,6 @@ } ], "operationId": "CreateIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1060,6 +1138,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1123,16 +1208,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1141,17 +1228,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "ip_access_control_lists": [], + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0", + "key": "ip_access_control_lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "ip_access_control_lists": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-02T17:29:34Z", + "date_updated": "2018-05-02T17:29:34Z", + "friendly_name": "friendly_name", + "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0", + "key": "ip_access_control_lists", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0" } } } @@ -1166,10 +1291,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "ListIpAccessControlList" } }, "/v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}": { @@ -1187,8 +1309,8 @@ "priority", "weight" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1224,6 +1346,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" + }, + "examples": { + "fetch": { + "value": { + "weight": 1, + "date_updated": "2018-05-07T20:20:46Z", + "enabled": false, + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 1, + "sip_url": "sip://sip-box.com:1234", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-07T20:20:46Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1235,10 +1374,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOriginationUrl" }, "delete": { "description": "", @@ -1278,10 +1414,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteOriginationUrl" }, "post": { "description": "", @@ -1317,6 +1450,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" + }, + "examples": { + "update": { + "value": { + "weight": 2, + "date_updated": "2018-05-07T20:50:58Z", + "enabled": false, + "friendly_name": "updated_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 2, + "sip_url": "sip://sip-updated.com:4321", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-07T20:50:58Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1329,9 +1479,6 @@ } ], "operationId": "UpdateOriginationUrl", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1361,6 +1508,17 @@ "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "Weight": 2, + "Priority": 2, + "SipUrl": "sip://sip-updated.com:4321", + "Enabled": false + } + } } } } @@ -1382,8 +1540,8 @@ "priority", "weight" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1407,6 +1565,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" + }, + "examples": { + "create": { + "value": { + "weight": 1, + "date_updated": "2018-05-07T20:50:58Z", + "enabled": true, + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 1, + "sip_url": "sip://sip-box.com:1234", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-07T20:50:58Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1419,9 +1594,6 @@ } ], "operationId": "CreateOriginationUrl", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1458,6 +1630,17 @@ "FriendlyName", "SipUrl" ] + }, + "examples": { + "create": { + "value": { + "Enabled": true, + "FriendlyName": "friendly_name", + "Priority": 1, + "Weight": 1, + "SipUrl": "sip://sip-box.com:1234" + } + } } } } @@ -1521,16 +1704,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1539,18 +1724,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0", + "key": "origination_urls", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0" + }, + "origination_urls": [ + { + "weight": 1, + "date_updated": "2018-05-09T20:47:35Z", + "enabled": true, + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "priority": 1, + "sip_url": "sip://sip-box.com:1234", + "sid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2018-05-09T20:47:35Z", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0", + "key": "origination_urls", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0" + }, + "origination_urls": [] } } } @@ -1564,10 +1791,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "ListOriginationUrl" } }, "/v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}": { @@ -1583,8 +1807,8 @@ "friendly_name", "phone_number" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1620,6 +1844,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.phone_number" + }, + "examples": { + "fetch": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-12-10T17:27:34Z", + "date_updated": "2015-10-09T11:36:32Z", + "friendly_name": "(415) 867-5309", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+14158675309", + "api_version": "2010-04-01", + "voice_caller_id_lookup": null, + "voice_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call", + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": null, + "status_callback": "", + "status_callback_method": "POST", + "voice_application_sid": "", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "beta": false, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capabilities": { + "voice": true, + "sms": true, + "mms": true + }, + "links": { + "phone_number": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } } } }, @@ -1631,10 +1893,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" }, "delete": { "description": "", @@ -1674,10 +1933,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "DeletePhoneNumber" } }, "/v1/Trunks/{TrunkSid}/PhoneNumbers": { @@ -1693,8 +1949,8 @@ "friendly_name", "phone_number" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1718,6 +1974,44 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.phone_number" + }, + "examples": { + "create": { + "value": { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-12-10T17:27:34Z", + "date_updated": "2015-10-09T11:36:32Z", + "friendly_name": "(415) 867-5309", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+14158675309", + "api_version": "2010-04-01", + "voice_caller_id_lookup": null, + "voice_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call", + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": null, + "status_callback": "", + "status_callback_method": "POST", + "voice_application_sid": "", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "beta": false, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capabilities": { + "voice": true, + "sms": true, + "mms": true + }, + "links": { + "phone_number": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } } } }, @@ -1730,9 +2024,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1751,6 +2042,13 @@ "required": [ "PhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1814,16 +2112,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1832,18 +2132,81 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0", + "key": "phone_numbers", + "next_page_url": null, + "page": 0, + "page_size": 1, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0" + }, + "phone_numbers": [ + { + "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2010-12-10T17:27:34Z", + "date_updated": "2015-10-09T11:36:32Z", + "friendly_name": "(415) 867-5309", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+14158675309", + "api_version": "2010-04-01", + "voice_caller_id_lookup": null, + "voice_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call", + "voice_method": "POST", + "voice_fallback_url": null, + "voice_fallback_method": null, + "status_callback": "", + "status_callback_method": "POST", + "voice_application_sid": "", + "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sms_url": "https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message", + "sms_method": "POST", + "sms_fallback_url": "", + "sms_fallback_method": "POST", + "sms_application_sid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_requirements": "none", + "beta": false, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capabilities": { + "voice": true, + "sms": true, + "mms": true + }, + "links": { + "phone_number": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0", + "key": "phone_numbers", + "next_page_url": null, + "page": 0, + "page_size": 1, + "previous_page_url": null, + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0" + }, + "phone_numbers": [] } } } @@ -1857,10 +2220,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Trunks/{TrunkSid}/Recording": { @@ -1875,9 +2235,9 @@ "mode", "trim" ], - "pathType": "instance", "parent": "/Trunks/{Sid}", - "mountName": "recordings" + "mountName": "recordings", + "pathType": "instance" }, "get": { "description": "", @@ -1901,6 +2261,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.recording" + }, + "examples": { + "fetch": { + "value": { + "mode": "do-not-record", + "trim": "do-not-trim" + } + } } } }, @@ -1912,10 +2280,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "post": { "description": "", @@ -1939,6 +2304,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.recording" + }, + "examples": { + "update": { + "value": { + "mode": "do-not-record", + "trim": "do-not-trim" + } + } } } }, @@ -1951,9 +2324,6 @@ } ], "operationId": "UpdateRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1972,6 +2342,14 @@ "description": "The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence." } } + }, + "examples": { + "update": { + "value": { + "Mode": "do-not-record", + "Trim": "do-not-trim" + } + } } } } @@ -1991,14 +2369,14 @@ "friendly_name", "domain_name" ], - "pathType": "instance", "dependentProperties": { "origination_url": "{trunk_sid: sid}", "credential_list": "{trunk_sid: sid}", "ip_access_control_list": "{trunk_sid: sid}", "phone_number": "{trunk_sid: sid}", "recording": "{trunk_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -2022,6 +2400,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk" + }, + "examples": { + "fetch": { + "value": { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "POST", + "disaster_recovery_url": "http://disaster-recovery.com", + "friendly_name": "friendly_name", + "secure": false, + "cnam_lookup_enabled": false, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferor", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + } } } }, @@ -2033,10 +2442,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunk" }, "delete": { "description": "", @@ -2064,10 +2470,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrunk" }, "post": { "description": "", @@ -2091,6 +2494,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk" + }, + "examples": { + "update": { + "value": { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "GET", + "disaster_recovery_url": "http://updated-recovery.com", + "friendly_name": "updated_name", + "secure": true, + "cnam_lookup_enabled": true, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferor", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + } } } }, @@ -2103,9 +2537,6 @@ } ], "operationId": "UpdateTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2158,6 +2589,19 @@ "description": "Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "DisasterRecoveryMethod": "GET", + "DisasterRecoveryUrl": "http://updated-recovery.com", + "Secure": true, + "TransferMode": "disable-all", + "TransferCallerId": "from-transferor", + "CnamLookupEnabled": true + } + } } } } @@ -2177,14 +2621,14 @@ "friendly_name", "domain_name" ], - "pathType": "list", "dependentProperties": { "origination_url": "{trunk_sid: sid}", "credential_list": "{trunk_sid: sid}", "ip_access_control_list": "{trunk_sid: sid}", "phone_number": "{trunk_sid: sid}", "recording": "{trunk_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -2194,6 +2638,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk" + }, + "examples": { + "create": { + "value": { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "POST", + "disaster_recovery_url": "http://disaster-recovery.com", + "friendly_name": "friendly_name", + "secure": false, + "cnam_lookup_enabled": false, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferee", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + } } } }, @@ -2206,9 +2681,6 @@ } ], "operationId": "CreateTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2261,6 +2733,20 @@ "description": "Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`." } } + }, + "examples": { + "create": { + "value": { + "DomainName": "test.pstn.twilio.com", + "FriendlyName": "friendly_name", + "DisasterRecoveryMethod": "GET", + "DisasterRecoveryUrl": "http://disaster-recovery.com", + "TransferMode": "disable-all", + "TransferCallerId": "from-transferee", + "Secure": false, + "CnamLookupEnabled": false + } + } } } } @@ -2312,16 +2798,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2330,18 +2818,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "page_size": 50, + "key": "trunks", + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "trunks": [ + { + "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "domain_name": "test.pstn.twilio.com", + "disaster_recovery_method": "POST", + "disaster_recovery_url": "http://disaster-recovery.com", + "friendly_name": "friendly_name", + "secure": false, + "cnam_lookup_enabled": false, + "recording": { + "mode": "do-not-record", + "trim": "do-not-trim" + }, + "transfer_mode": "disable-all", + "transfer_caller_id": "from-transferee", + "auth_type": "", + "auth_type_set": [], + "date_created": "2015-01-02T11:23:45Z", + "date_updated": "2015-01-02T11:23:45Z", + "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls", + "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists", + "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists", + "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "url": "https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0", + "page_size": 50, + "key": "trunks", + "next_page_url": null, + "page": 0, + "previous_page_url": null + }, + "trunks": [] } } } @@ -2355,10 +2899,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrunk" } } }, @@ -2366,11 +2907,5 @@ { "url": "https://trunking.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index 1499a819..d9f7ee43 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "trusthub.v1.customer_profile": { "type": "object", @@ -768,12 +774,6 @@ "noncompliant" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -789,7 +789,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -799,20 +799,20 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "policy_sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "customer_profiles_entity_assignments": "{customer_profile_sid: sid}", "customer_profiles_evaluations": "{customer_profile_sid: sid}", "customer_profiles_channel_endpoint_assignment": "{customer_profile_sid: sid}" }, - "className": "customer_profiles" + "className": "customer_profiles", + "pathType": "list" }, "post": { "description": "Create a new Customer-Profile.", @@ -822,6 +822,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -834,9 +856,6 @@ } ], "operationId": "CreateCustomerProfile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -870,6 +889,16 @@ "Email", "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -885,6 +914,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/customer_profile_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + } } }, { @@ -893,6 +927,11 @@ "description": "The string that you assigned to describe the resource.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -904,6 +943,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -949,16 +993,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -967,17 +1013,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "provisionally-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2020-07-31T01:00:00Z", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -992,10 +1085,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfile" } }, "/v1/CustomerProfiles/{Sid}": { @@ -1004,20 +1094,20 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "policy_sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "customer_profiles_entity_assignments": "{customer_profile_sid: sid}", "customer_profiles_evaluations": "{customer_profile_sid: sid}", "customer_profiles_channel_endpoint_assignment": "{customer_profile_sid: sid}" }, - "className": "customer_profiles" + "className": "customer_profiles", + "pathType": "instance" }, "get": { "description": "Fetch a specific Customer-Profile instance.", @@ -1041,6 +1131,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile" + }, + "examples": { + "fetch": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": null, + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -1052,10 +1164,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfile" }, "post": { "description": "Updates a Customer-Profile in an account.", @@ -1079,6 +1188,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile" + }, + "examples": { + "update": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + }, + "updateToInReview": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "in-review", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -1091,9 +1242,6 @@ } ], "operationId": "UpdateCustomerProfile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1120,6 +1268,21 @@ "description": "The email address that will receive updates when the Customer-Profile resource changes status." } } + }, + "examples": { + "update": { + "value": { + "Status": "draft", + "StatusCallback": "http://www.example.com", + "FriendlyName": "friendly_name", + "Email": "email" + } + }, + "updateToInReview": { + "value": { + "Status": "pending-review" + } + } } } } @@ -1151,10 +1314,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfile" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments": { @@ -1163,14 +1323,14 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/CustomerProfiles/{Sid}", - "mountName": "customer_profiles_channel_endpoint_assignment" + "mountName": "customer_profiles_channel_endpoint_assignment", + "pathType": "list" }, "post": { "description": "Create a new Assigned Item.", @@ -1194,6 +1354,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1206,9 +1379,6 @@ } ], "operationId": "CreateCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1232,6 +1402,14 @@ "ChannelEndpointType", "ChannelEndpointSid" ] + }, + "examples": { + "create": { + "value": { + "ChannelEndpointSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelEndpointType": "phone-number" + } + } } } } @@ -1261,6 +1439,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1314,16 +1497,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1332,17 +1517,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1357,10 +1580,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileChannelEndpointAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}": { @@ -1369,14 +1589,14 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/CustomerProfiles/{Sid}", - "mountName": "customer_profiles_channel_endpoint_assignment" + "mountName": "customer_profiles_channel_endpoint_assignment", + "pathType": "instance" }, "get": { "description": "Fetch specific Assigned Item Instance.", @@ -1412,6 +1632,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1423,10 +1656,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileChannelEndpointAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -1466,10 +1696,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfileChannelEndpointAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments": { @@ -1478,15 +1705,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/CustomerProfiles/{Sid}", "mountName": "customer_profiles_entity_assignments", - "className": "customer_profiles_entity_assignments" + "className": "customer_profiles_entity_assignments", + "pathType": "list" }, "post": { "description": "Create a new Assigned Item.", @@ -1510,6 +1737,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1522,9 +1761,6 @@ } ], "operationId": "CreateCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1543,6 +1779,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1606,16 +1849,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1624,17 +1869,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1649,10 +1931,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileEntityAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}": { @@ -1661,15 +1940,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/CustomerProfiles/{Sid}", "mountName": "customer_profiles_entity_assignments", - "className": "customer_profiles_entity_assignments" + "className": "customer_profiles_entity_assignments", + "pathType": "instance" }, "get": { "description": "Fetch specific Assigned Item Instance.", @@ -1705,6 +1984,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1716,10 +2007,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileEntityAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -1759,10 +2047,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfileEntityAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations": { @@ -1771,15 +2056,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/CustomerProfiles/{Sid}", "mountName": "customer_profiles_evaluations", - "className": "customer_profiles_evaluations" + "className": "customer_profiles_evaluations", + "pathType": "list" }, "post": { "description": "Create a new Evaluation", @@ -1803,6 +2088,326 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation" + }, + "examples": { + "create": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + }, + "createCompliantStarterCustomerProfile": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "compliant", + "date_created": "2023-03-15T13:51:57Z", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "valid": [ + { + "object_field": "first_name", + "error_code": null, + "friendly_name": "First Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "last_name", + "error_code": null, + "friendly_name": "Last Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "email", + "error_code": null, + "friendly_name": "Email Address", + "passed": true, + "failure_reason": null + }, + { + "object_field": "phone_number", + "error_code": null, + "friendly_name": "Phone Number", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "starter_customer_profile_information", + "friendly_name": "Information", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Starter Customer Profile Information", + "error_code": null, + "requirement_name": "starter_customer_profile_information" + }, + { + "valid": [ + { + "object_field": "address_sids", + "error_code": null, + "friendly_name": "address sids", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "customer_profile_address", + "friendly_name": "Legal Company Address", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Customer Profile Address", + "error_code": null, + "requirement_name": "customer_profile_address" + }, + { + "valid": [ + { + "object_field": "bundle_sid", + "error_code": null, + "friendly_name": "Supporting Bundle Status", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "primary_customer_profile_type_business", + "friendly_name": "Primary Customer Profile Bundle", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Primary Customer Profile", + "error_code": null, + "requirement_name": "primary_customer_profile" + } + ] + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "compliant", + "date_created": "2023-03-15T13:51:57Z", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "valid": [ + { + "object_field": "brand_name", + "error_code": null, + "friendly_name": "Brand Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "mobile_phone_number", + "error_code": null, + "friendly_name": "Mobile Phone Number", + "passed": true, + "failure_reason": null + }, + { + "object_field": "vertical", + "error_code": null, + "friendly_name": "Vertical", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "sole_proprietor_information", + "friendly_name": "Sole Proprietor Information", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Sole Proprietor Information", + "error_code": null, + "requirement_name": "sole_proprietor_information" + }, + { + "valid": [ + { + "object_field": "bundle_status", + "error_code": null, + "friendly_name": "Supporting Bundle Status", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "starter_customer_profile_type_business", + "friendly_name": "Starter Customer Profile(isv customers) Proof", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Customer Profile", + "error_code": null, + "requirement_name": "customer_profile" + } + ] + } + } } } }, @@ -1815,9 +2420,6 @@ } ], "operationId": "CreateCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1836,6 +2438,23 @@ "required": [ "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantStarterCustomerProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1899,16 +2518,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1917,17 +2538,206 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -1942,10 +2752,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileEvaluation" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}": { @@ -1954,15 +2761,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/CustomerProfiles/{Sid}", "mountName": "customer_profiles_evaluations", - "className": "customer_profiles_evaluations" + "className": "customer_profiles_evaluations", + "pathType": "instance" }, "get": { "description": "Fetch specific Evaluation Instance.", @@ -1998,6 +2805,170 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation" + }, + "examples": { + "fetch": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, @@ -2009,10 +2980,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileEvaluation" } }, "/v1/EndUsers": { @@ -2021,7 +2989,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2037,6 +3005,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user" + }, + "examples": { + "create": { + "value": { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "auth_rep_1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + } } } }, @@ -2049,9 +3038,6 @@ } ], "operationId": "CreateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2075,6 +3061,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "auth_rep_1", + "Type": "authorized_representative_1", + "Attributes": "{}" + } + } } } } @@ -2126,16 +3121,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2144,17 +3141,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "auth_rep_1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2169,10 +3212,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUser" } }, "/v1/EndUsers/{Sid}": { @@ -2181,7 +3221,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2211,6 +3251,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user" + }, + "examples": { + "fetch": { + "value": { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "auth_rep_1", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + } } } }, @@ -2222,10 +3283,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUser" }, "post": { "description": "Update an existing End User.", @@ -2249,6 +3307,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user" + }, + "examples": { + "update": { + "value": { + "date_updated": "2021-02-16T20:40:57Z", + "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-16T20:40:57Z", + "attributes": { + "phone_number": "+11234567890", + "job_position": "CEO", + "first_name": "rep1", + "last_name": "test", + "business_title": "ceo", + "email": "foobar@test.com" + }, + "type": "authorized_representative_1" + } + } } } }, @@ -2261,9 +3340,6 @@ } ], "operationId": "UpdateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2279,6 +3355,14 @@ "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -2310,10 +3394,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEndUser" } }, "/v1/EndUserTypes": { @@ -2322,7 +3403,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2376,16 +3457,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2394,19 +3477,86 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "end_user_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" } } + }, + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "end_user_types" + }, + "end_user_types": [ + { + "url": "https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "email", + "friendly_name": "Email", + "constraint": "String" + }, + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "business_title", + "friendly_name": "Business Title", + "constraint": "String" + }, + { + "machine_name": "phone_number", + "friendly_name": "Phone Number", + "constraint": "String" + }, + { + "machine_name": "job_position", + "friendly_name": "Job Position", + "constraint": "String" + } + ], + "machine_name": "authorized_representative_1", + "friendly_name": "Authorized Representative one", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -2419,10 +3569,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUserType" } }, "/v1/EndUserTypes/{Sid}": { @@ -2431,7 +3578,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2458,6 +3605,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.end_user_type" + }, + "examples": { + "fetch": { + "value": { + "url": "https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "email", + "friendly_name": "Email", + "constraint": "String" + }, + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "business_title", + "friendly_name": "Business Title", + "constraint": "String" + }, + { + "machine_name": "phone_number", + "friendly_name": "Phone Number", + "constraint": "String" + }, + { + "machine_name": "job_position", + "friendly_name": "Job Position", + "constraint": "String" + } + ], + "machine_name": "authorized_representative_1", + "friendly_name": "Authorized Representative one", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2469,10 +3658,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUserType" } }, "/v1/Policies": { @@ -2481,14 +3667,14 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "list", - "className": "policies" + "className": "policies", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Policys.", @@ -2536,16 +3722,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2554,19 +3742,124 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } + }, + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + }, + "results": [ + { + "url": "https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/customer_profile_business_information", + "fields": [ + "business_type", + "business_registration_number", + "business_name", + "business_registration_identifier", + "business_identity", + "business_industry", + "website_url", + "business_regions_of_operation", + "social_media_profile_urls" + ], + "type": "customer_profile_business_information", + "name": "Business Information", + "requirement_name": "customer_profile_business_information" + }, + { + "url": "/EndUserTypes/authorized_representative_1", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_1", + "name": "Authorized Representative 1", + "requirement_name": "authorized_representative_1" + }, + { + "url": "/EndUserTypes/authorized_representative_2", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_2", + "name": "Authorized Representative 2", + "requirement_name": "authorized_representative_2" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [ + { + "description": "Customer Profile HQ Physical Address", + "type": "document", + "name": "Physical Business Address", + "accepted_documents": [ + { + "url": "/SupportingDocumentTypes/customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "customer_profile_address", + "name": "Physical Business Address" + } + ], + "requirement_name": "customer_profile_address" + } + ] + ], + "supporting_customer_profiles": [] + }, + "friendly_name": "Primary Customer Profile of type Business", + "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } } } } @@ -2579,10 +3872,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPolicies", - "x-maturity": [ - "GA" - ] + "operationId": "ListPolicies" } }, "/v1/Policies/{Sid}": { @@ -2591,14 +3881,14 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name" ], - "pathType": "instance", - "className": "policies" + "className": "policies", + "pathType": "instance" }, "get": { "description": "Fetch specific Policy Instance.", @@ -2622,6 +3912,183 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.policies" + }, + "examples": { + "fetch": { + "value": { + "url": "https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/customer_profile_business_information", + "fields": [ + "business_type", + "business_registration_number", + "business_name", + "business_registration_identifier", + "business_identity", + "business_industry", + "website_url", + "business_regions_of_operation", + "social_media_profile_urls" + ], + "type": "customer_profile_business_information", + "name": "Business Information", + "requirement_name": "customer_profile_business_information" + }, + { + "url": "/EndUserTypes/authorized_representative_1", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_1", + "name": "Authorized Representative 1", + "requirement_name": "authorized_representative_1" + }, + { + "url": "/EndUserTypes/authorized_representative_2", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number", + "business_title", + "job_position" + ], + "type": "authorized_representative_2", + "name": "Authorized Representative 2", + "requirement_name": "authorized_representative_2" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [ + { + "description": "Customer Profile HQ Physical Address", + "type": "document", + "name": "Physical Business Address", + "accepted_documents": [ + { + "url": "/SupportingDocumentTypes/customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "customer_profile_address", + "name": "Physical Business Address" + } + ], + "requirement_name": "customer_profile_address" + } + ] + ], + "supporting_customer_profiles": [] + }, + "friendly_name": "Primary Customer Profile of type Business", + "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchStarterCustomerProfilePolicy": { + "value": { + "url": "https://trusthub.twilio.com/v1/Policies/RN806dd6cd175f314e1f96a9727ee271f4", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/starter_customer_profile_information", + "fields": [ + "first_name", + "last_name", + "email", + "phone_number" + ], + "type": "starter_customer_profile_information", + "name": "Information", + "requirement_name": "starter_customer_profile_information" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [ + { + "description": "Customer Profile Address", + "type": "document", + "name": "Customer Profile Address", + "accepted_documents": [ + { + "url": "/SupportingDocumentTypes/customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "customer_profile_address", + "name": "Legal Company Address" + }, + { + "url": "/SupportingDocumentTypes/starter_customer_profile_address", + "fields": [ + "address_sids" + ], + "type": "starter_customer_profile_address", + "name": "Legal Company Address" + } + ], + "requirement_name": "customer_profile_address" + } + ] + ], + "supporting_customer_profiles": [ + { + "type": "primary_customer_profile_type_business", + "name": "Primary Customer Profile Bundle", + "requirement_name": "primary_customer_profile" + } + ] + }, + "friendly_name": "Starter Customer Profile of type Business", + "sid": "RN806dd6cd175f314e1f96a9727ee271f4" + } + }, + "fetchSoleProprietorTrustBundlePolicy": { + "value": { + "url": "https://trusthub.twilio.com/v1/Policies/RN670d5d2e282a6130ae063b234b6019c8", + "requirements": { + "end_user": [ + { + "url": "/EndUserTypes/sole_proprietor_information", + "fields": [ + "brand_name", + "mobile_phone_number", + "vertical" + ], + "type": "sole_proprietor_information", + "name": "Sole Proprietor Information", + "requirement_name": "sole_proprietor_information" + } + ], + "supporting_trust_products": [], + "supporting_document": [ + [] + ], + "supporting_customer_profiles": [ + { + "type": "starter_customer_profile_type_business", + "name": "Starter Customer Profile(isv customers) Proof", + "requirement_name": "customer_profile" + }, + { + "type": "starter_customer_profile_type_direct_long_tail", + "name": "Starter Customer Profile(direct customers) Proof", + "requirement_name": "customer_profile" + } + ] + }, + "friendly_name": "Sole Proprietor TrustProduct", + "sid": "RN670d5d2e282a6130ae063b234b6019c8" + } + } } } }, @@ -2633,10 +4100,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPolicies", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPolicies" } }, "/v1/SupportingDocuments": { @@ -2645,7 +4109,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2661,6 +4125,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document" + }, + "examples": { + "create": { + "value": { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "Business-profile-physical-address", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + } } } }, @@ -2673,9 +4155,6 @@ } ], "operationId": "CreateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2699,6 +4178,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Business-profile-physical-address", + "Type": "customer_profile_address", + "Attributes": "{}" + } + } } } } @@ -2750,16 +4238,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2768,17 +4258,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "Business-profile-physical-address", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -2793,10 +4326,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocument" } }, "/v1/SupportingDocuments/{Sid}": { @@ -2805,7 +4335,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2835,6 +4365,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document" + }, + "examples": { + "fetch": { + "value": { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "Business-profile-physical-address", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + } } } }, @@ -2846,10 +4394,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocument" }, "post": { "description": "Update an existing Supporting Document.", @@ -2873,6 +4418,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document" + }, + "examples": { + "update": { + "value": { + "status": "draft", + "date_updated": "2021-02-11T17:23:00Z", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-02-11T17:23:00Z", + "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "attributes": { + "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "type": "customer_profile_address", + "mime_type": null + } + } } } }, @@ -2885,9 +4448,6 @@ } ], "operationId": "UpdateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2903,6 +4463,14 @@ "description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Attributes": "{}" + } + } } } } @@ -2934,10 +4502,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSupportingDocument" } }, "/v1/SupportingDocumentTypes": { @@ -2946,7 +4511,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3000,16 +4565,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3018,17 +4585,82 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "supporting_document_types": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" + } + } + }, + "readFull": { + "value": { + "supporting_document_types": [ + { + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "address_sids", + "friendly_name": "Address Sids", + "constraint": "List" + } + ], + "machine_name": "customer_profile_address", + "friendly_name": "Customer profile address", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "business_name", + "friendly_name": "Business Name", + "constraint": "String" + } + ], + "machine_name": "government_issued_proof_of_authorized_representative", + "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0", + "next_page_url": null, + "key": "supporting_document_types" } } } @@ -3043,10 +4675,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocumentType" } }, "/v1/SupportingDocumentTypes/{Sid}": { @@ -3055,7 +4684,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3082,6 +4711,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.supporting_document_type" + }, + "examples": { + "fetch": { + "value": { + "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "constraint": "String" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "constraint": "String" + }, + { + "machine_name": "business_name", + "friendly_name": "Business Name", + "constraint": "String" + } + ], + "machine_name": "government_issued_proof_of_authorized_representative", + "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company", + "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3093,10 +4749,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocumentType" } }, "/v1/TrustProducts": { @@ -3105,20 +4758,20 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "policy_sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "trust_products_entity_assignments": "{trust_product_sid: sid}", "trust_products_evaluations": "{trust_product_sid: sid}", "trust_products_channel_endpoint_assignment": "{trust_product_sid: sid}" }, - "className": "trust_products" + "className": "trust_products", + "pathType": "list" }, "post": { "description": "Create a new Customer-Profile.", @@ -3128,6 +4781,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product" + }, + "examples": { + "create": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -3140,9 +4815,6 @@ } ], "operationId": "CreateTrustProduct", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3176,6 +4848,16 @@ "Email", "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -3191,6 +4873,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/trust_product_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + } } }, { @@ -3199,6 +4886,11 @@ "description": "The string that you assigned to describe the resource.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -3210,6 +4902,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3255,16 +4952,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3273,17 +4972,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "provisionally-approved", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": "2020-07-31T01:00:00Z", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -3298,10 +5044,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProduct" } }, "/v1/TrustProducts/{Sid}": { @@ -3310,20 +5053,20 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "policy_sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "trust_products_entity_assignments": "{trust_product_sid: sid}", "trust_products_evaluations": "{trust_product_sid: sid}", "trust_products_channel_endpoint_assignment": "{trust_product_sid: sid}" }, - "className": "trust_products" + "className": "trust_products", + "pathType": "instance" }, "get": { "description": "Fetch a specific Customer-Profile instance.", @@ -3347,6 +5090,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product" + }, + "examples": { + "fetch": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "valid_until": null, + "email": "email", + "status_callback": "http://www.example.com", + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -3358,10 +5123,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProduct" }, "post": { "description": "Updates a Customer-Profile in an account.", @@ -3385,6 +5147,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product" + }, + "examples": { + "update": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "draft", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + }, + "updateToInReview": { + "value": { + "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "status": "in-review", + "email": "email", + "status_callback": "http://www.example.com", + "valid_until": null, + "date_created": "2019-07-30T22:29:24Z", + "date_updated": "2019-07-31T01:09:00Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "trust_products_entity_assignments": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments", + "trust_products_evaluations": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations", + "trust_products_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments" + } + } + } } } }, @@ -3397,9 +5201,6 @@ } ], "operationId": "UpdateTrustProduct", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3426,6 +5227,21 @@ "description": "The email address that will receive updates when the Customer-Profile resource changes status." } } + }, + "examples": { + "update": { + "value": { + "Status": "draft", + "StatusCallback": "http://www.example.com", + "FriendlyName": "friendly_name", + "Email": "email" + } + }, + "updateToInReview": { + "value": { + "Status": "pending-review" + } + } } } } @@ -3457,10 +5273,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProduct" } }, "/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments": { @@ -3469,14 +5282,14 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/TrustProducts/{Sid}", - "mountName": "trust_products_channel_endpoint_assignment" + "mountName": "trust_products_channel_endpoint_assignment", + "pathType": "list" }, "post": { "description": "Create a new Assigned Item.", @@ -3500,6 +5313,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3512,9 +5338,6 @@ } ], "operationId": "CreateTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3538,6 +5361,14 @@ "ChannelEndpointType", "ChannelEndpointSid" ] + }, + "examples": { + "create": { + "value": { + "ChannelEndpointSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelEndpointType": "phone-number" + } + } } } } @@ -3567,6 +5398,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3620,16 +5456,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3638,17 +5476,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -3663,10 +5539,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductChannelEndpointAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}": { @@ -3675,14 +5548,14 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/TrustProducts/{Sid}", - "mountName": "trust_products_channel_endpoint_assignment" + "mountName": "trust_products_channel_endpoint_assignment", + "pathType": "instance" }, "get": { "description": "Fetch specific Assigned Item Instance.", @@ -3718,6 +5591,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_type": "phone-number", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3729,10 +5615,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductChannelEndpointAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -3772,10 +5655,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProductChannelEndpointAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/EntityAssignments": { @@ -3784,15 +5664,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/TrustProducts/{Sid}", "mountName": "trust_products_entity_assignments", - "className": "trust_products_entity_assignments" + "className": "trust_products_entity_assignments", + "pathType": "list" }, "post": { "description": "Create a new Assigned Item.", @@ -3816,6 +5696,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment" + }, + "examples": { + "create": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3828,9 +5720,6 @@ } ], "operationId": "CreateTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3849,6 +5738,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3912,16 +5808,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3930,17 +5828,54 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -3955,10 +5890,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductEntityAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}": { @@ -3967,15 +5899,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/TrustProducts/{Sid}", "mountName": "trust_products_entity_assignments", - "className": "trust_products_entity_assignments" + "className": "trust_products_entity_assignments", + "pathType": "instance" }, "get": { "description": "Fetch specific Assigned Item Instance.", @@ -4011,6 +5943,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment" + }, + "examples": { + "fetch": { + "value": { + "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2019-07-31T02:34:41Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4022,10 +5966,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductEntityAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -4065,10 +6006,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProductEntityAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/Evaluations": { @@ -4077,15 +6015,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "parent": "/TrustProducts/{Sid}", "mountName": "trust_products_evaluations", - "className": "trust_products_evaluations" + "className": "trust_products_evaluations", + "pathType": "list" }, "post": { "description": "Create a new Evaluation", @@ -4109,6 +6047,235 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation" + }, + "examples": { + "create": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "compliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "valid": [ + { + "object_field": "brand_name", + "error_code": null, + "friendly_name": "Brand Name", + "passed": true, + "failure_reason": null + }, + { + "object_field": "mobile_phone_number", + "error_code": null, + "friendly_name": "Mobile Phone Number", + "passed": true, + "failure_reason": null + }, + { + "object_field": "vertical", + "error_code": null, + "friendly_name": "Vertical", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "sole_proprietor_information", + "friendly_name": "Sole Proprietor Information", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Sole Proprietor Information", + "error_code": null, + "requirement_name": "sole_proprietor_information" + }, + { + "valid": [ + { + "object_field": "bundle_status", + "error_code": null, + "friendly_name": "Supporting Bundle Status", + "passed": true, + "failure_reason": null + } + ], + "invalid": [], + "object_type": "starter_customer_profile_type_business", + "friendly_name": "Starter Customer Profile(isv customers) Proof", + "failure_reason": null, + "passed": true, + "requirement_friendly_name": "Customer Profile", + "error_code": null, + "requirement_name": "customer_profile" + } + ] + } + } } } }, @@ -4121,9 +6288,6 @@ } ], "operationId": "CreateTrustProductEvaluation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4142,6 +6306,18 @@ "required": [ "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4205,16 +6381,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4223,17 +6401,206 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "results": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" + } + } + }, + "readFull": { + "value": { + "results": [ + { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0", + "next_page_url": null, + "key": "results" } } } @@ -4248,10 +6615,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductEvaluation" } }, "/v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}": { @@ -4260,15 +6624,15 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "parent": "/TrustProducts/{Sid}", "mountName": "trust_products_evaluations", - "className": "trust_products_evaluations" + "className": "trust_products_evaluations", + "pathType": "instance" }, "get": { "description": "Fetch specific Evaluation Instance.", @@ -4304,6 +6668,170 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation" + }, + "examples": { + "fetch": { + "value": { + "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "noncompliant", + "date_created": "2020-04-28T18:14:01Z", + "url": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "results": [ + { + "friendly_name": "Business", + "object_type": "business", + "passed": false, + "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.", + "error_code": 22214, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Business Registration Number", + "object_field": "business_registration_number", + "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.", + "error_code": 22215 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.", + "error_code": 22215 + } + ], + "requirement_friendly_name": "Business", + "requirement_name": "business_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Business Name", + "object_field": "business_name", + "failure_reason": "The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Name", + "requirement_name": "business_name_info" + }, + { + "friendly_name": "Excerpt from the commercial register showing French address", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Address sid(s)", + "object_field": "address_sids", + "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.", + "error_code": 22219 + } + ], + "requirement_friendly_name": "Business Address (Proof of Address)", + "requirement_name": "business_address_proof_info" + }, + { + "friendly_name": "Excerpt from the commercial register (Extrait K-bis)", + "object_type": "commercial_registrar_excerpt", + "passed": false, + "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "Document Number", + "object_field": "document_number", + "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Business Registration Number", + "requirement_name": "business_reg_no_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs.", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Authorized Representative", + "requirement_name": "name_of_auth_rep_info" + }, + { + "friendly_name": "Executed Copy of Power of Attorney", + "object_type": "power_of_attorney", + "passed": false, + "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [], + "requirement_friendly_name": "Power of Attorney", + "requirement_name": "power_of_attorney_info" + }, + { + "friendly_name": "Government-issued ID", + "object_type": "government_issued_document", + "passed": false, + "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.", + "error_code": 22216, + "valid": [], + "invalid": [ + { + "friendly_name": "First Name", + "object_field": "first_name", + "failure_reason": "The First Name is missing on the Governnment-Issued ID.", + "error_code": 22217 + }, + { + "friendly_name": "Last Name", + "object_field": "last_name", + "failure_reason": "The Last Name is missing on the Government-issued ID", + "error_code": 22217 + } + ], + "requirement_friendly_name": "Name of Person granted the Power of Attorney", + "requirement_name": "name_in_power_of_attorney_info" + } + ] + } + } } } }, @@ -4315,10 +6843,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductEvaluation" } } }, @@ -4326,11 +6851,5 @@ { "url": "https://trusthub.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 3ea5a6e6..bc6b731a 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "verify.v2.service.access_token": { "type": "object", @@ -1427,12 +1433,6 @@ "POST" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1448,7 +1448,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1458,7 +1458,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1471,8 +1471,8 @@ "ttl", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new enrollment Access Token for the Entity", @@ -1496,6 +1496,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.access_token" + }, + "examples": { + "createWithTtl": { + "value": { + "sid": "YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_type": "push", + "factor_friendly_name": "John Doe iPhone", + "ttl": 300, + "date_created": "2015-07-30T20:00:00Z", + "token": "eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithoutTtl": { + "value": { + "sid": "YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_type": "push", + "factor_friendly_name": "John Doe iPhone", + "ttl": 60, + "date_created": "2015-07-30T20:00:00Z", + "token": "eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1508,9 +1538,6 @@ } ], "operationId": "CreateAccessToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1540,6 +1567,23 @@ "Identity", "FactorType" ] + }, + "examples": { + "createWithTtl": { + "value": { + "FactorType": "push", + "FactorFriendlyName": "John Doe iPhone", + "Identity": "ff483d1ff591898a9942916050d2ca3f", + "Ttl": 300 + } + }, + "createWithoutTtl": { + "value": { + "FactorType": "push", + "FactorFriendlyName": "John Doe iPhone", + "Identity": "ff483d1ff591898a9942916050d2ca3f" + } + } } } } @@ -1552,7 +1596,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1565,8 +1609,8 @@ "ttl", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch an Access Token for the Entity", @@ -1602,6 +1646,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.access_token" + }, + "examples": { + "fetch": { + "value": { + "sid": "YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_type": "push", + "factor_friendly_name": "John Doe iPhone", + "ttl": 60, + "date_created": "2015-07-30T20:00:00Z", + "token": "eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1613,10 +1673,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccessToken", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccessToken" } }, "/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets": { @@ -1625,7 +1682,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1637,8 +1694,8 @@ "date_created", "date_updated" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/RateLimits/{Sid}" + "parent": "/Services/{ServiceSid}/RateLimits/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Bucket for a Rate Limit", @@ -1674,6 +1731,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" + }, + "examples": { + "createBucket": { + "value": { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1686,9 +1758,6 @@ } ], "operationId": "CreateBucket", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1709,6 +1778,14 @@ "Max", "Interval" ] + }, + "examples": { + "createBucket": { + "value": { + "Max": 5, + "Interval": 60 + } + } } } } @@ -1784,16 +1861,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1802,17 +1881,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "buckets": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "next_page_url": null, + "key": "buckets" + } + } + }, + "readFull": { + "value": { + "buckets": [ + { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0", + "next_page_url": null, + "key": "buckets" } } } @@ -1827,10 +1946,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBucket", - "x-maturity": [ - "GA" - ] + "operationId": "ListBucket" } }, "/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}": { @@ -1839,7 +1955,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1851,8 +1967,8 @@ "date_created", "date_updated" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/RateLimits/{Sid}" + "parent": "/Services/{ServiceSid}/RateLimits/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific Bucket.", @@ -1900,6 +2016,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" + }, + "examples": { + "updateBucket": { + "value": { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1912,9 +2043,6 @@ } ], "operationId": "UpdateBucket", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1931,6 +2059,14 @@ "description": "Number of seconds that the rate limit will be enforced over." } } + }, + "examples": { + "updateBucket": { + "value": { + "Max": 5, + "Interval": 60 + } + } } } } @@ -1982,6 +2118,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" + }, + "examples": { + "fetchBucket": { + "value": { + "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max": 5, + "interval": 60, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1993,10 +2144,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBucket", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBucket" }, "delete": { "description": "Delete a specific Bucket.", @@ -2048,10 +2196,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBucket", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBucket" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges": { @@ -2060,7 +2205,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "factor_type", @@ -2068,11 +2213,11 @@ "responded_reason", "date_created" ], - "pathType": "list", "dependentProperties": { "notification": "{service_sid: service_sid, identity: identity, challenge_sid: sid}" }, - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "list" }, "post": { "description": "Create a new Challenge for the Factor", @@ -2105,6 +2250,113 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge" + }, + "examples": { + "createPush": { + "value": { + "sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + }, + "createTotpWithoutAuthPayload": { + "value": { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + }, + "createTotpWithAuthPayload": { + "value": { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + } } } }, @@ -2117,9 +2369,6 @@ } ], "operationId": "CreateChallenge", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2159,6 +2408,42 @@ "required": [ "FactorSid" ] + }, + "examples": { + "createPush": { + "value": { + "FactorSid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ExpirationDate": "2015-07-30T20:00:00Z", + "Details.Message": "Hi! Mr. John Doe, would you like to sign up?", + "Details.Fields": [ + "{\"label\": \"Action\", \"value\": \"Sign up in portal\"}" + ], + "HiddenDetails": "{\"ip\": \"172.168.1.234\"}" + } + }, + "createTotpWithoutAuthPayload": { + "value": { + "FactorSid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ExpirationDate": "2015-07-30T20:00:00Z", + "Details.Message": "Hi! Mr. John Doe, would you like to sign up?", + "Details.Fields": [ + "{\"label\": \"Action\", \"value\": \"Sign up in portal\"}" + ], + "HiddenDetails": "{\"ip\": \"172.168.1.234\"}" + } + }, + "createTotpWithAuthPayload": { + "value": { + "FactorSid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ExpirationDate": "2015-07-30T20:00:00Z", + "Details.Message": "Hi! Mr. John Doe, would you like to sign up?", + "Details.Fields": [ + "{\"label\": \"Action\", \"value\": \"Sign up in portal\"}" + ], + "HiddenDetails": "{\"ip\": \"172.168.1.234\"}", + "AuthPayload": "12345678" + } + } } } } @@ -2260,16 +2545,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2278,17 +2565,112 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "challenges": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "next_page_url": null, + "key": "challenges" + } + } + }, + "readFull": { + "value": { + "challenges": [ + { + "sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + }, + { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "pending", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0", + "next_page_url": null, + "key": "challenges" } } } @@ -2303,10 +2685,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChallenge", - "x-maturity": [ - "GA" - ] + "operationId": "ListChallenge" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}": { @@ -2315,7 +2694,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "factor_type", @@ -2323,11 +2702,11 @@ "responded_reason", "date_created" ], - "pathType": "instance", "dependentProperties": { "notification": "{service_sid: service_sid, identity: identity, challenge_sid: sid}" }, - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Challenge.", @@ -2372,6 +2751,45 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge" + }, + "examples": { + "fetchSid": { + "value": { + "sid": "YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": { + "os": "Android" + }, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + } } } }, @@ -2383,10 +2801,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChallenge", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChallenge" }, "post": { "description": "Verify a specific Challenge.", @@ -2431,6 +2846,80 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge" + }, + "examples": { + "verifyPush": { + "value": { + "sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": { + "os": "Android" + }, + "factor_type": "push", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + }, + "verifyTotp": { + "value": { + "sid": "YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "factor_sid": "YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "date_responded": "2015-07-30T20:00:00Z", + "expiration_date": "2015-07-30T20:00:00Z", + "status": "approved", + "responded_reason": "none", + "details": { + "message": "Hi! Mr. John Doe, would you like to sign up?", + "date": "2020-07-01T12:13:14Z", + "fields": [ + { + "label": "Action", + "value": "Sign up in portal" + } + ] + }, + "hidden_details": { + "ip": "172.168.1.234" + }, + "metadata": null, + "factor_type": "totp", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "notifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications" + } + } + } } } }, @@ -2443,9 +2932,6 @@ } ], "operationId": "UpdateChallenge", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2461,6 +2947,19 @@ "description": "Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length." } } + }, + "examples": { + "verifyPush": { + "value": { + "AuthPayload": "123456", + "Metadata": "{\"os\": \"Android\"}" + } + }, + "verifyTotp": { + "value": { + "AuthPayload": "123456" + } + } } } } @@ -2473,20 +2972,20 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", "dependentProperties": { "factor": "{service_sid: service_sid, identity: identity}", "new_factor": "{service_sid: service_sid, identity: identity}", "challenge": "{service_sid: service_sid, identity: identity}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Entity for the Service", @@ -2510,6 +3009,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity" + }, + "examples": { + "create": { + "value": { + "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f", + "links": { + "factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "new_factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "challenges": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges" + } + } + } } } }, @@ -2522,9 +3039,6 @@ } ], "operationId": "CreateEntity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2540,6 +3054,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "ff483d1ff591898a9942916050d2ca3f" + } + } } } } @@ -2603,16 +3124,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2621,17 +3144,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "entities": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "next_page_url": null, + "key": "entities" + } + } + }, + "readFull": { + "value": { + "entities": [ + { + "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f", + "links": { + "factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "new_factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "challenges": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0", + "next_page_url": null, + "key": "entities" } } } @@ -2646,10 +3212,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEntity", - "x-maturity": [ - "GA" - ] + "operationId": "ListEntity" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}": { @@ -2658,20 +3221,20 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { "factor": "{service_sid: service_sid, identity: identity}", "new_factor": "{service_sid: service_sid, identity: identity}", "challenge": "{service_sid: service_sid, identity: identity}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Entity.", @@ -2708,10 +3271,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEntity", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEntity" }, "get": { "description": "Fetch a specific Entity.", @@ -2744,6 +3304,24 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity" + }, + "examples": { + "fetch": { + "value": { + "sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f", + "links": { + "factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "new_factors": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors", + "challenges": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges" + } + } + } } } }, @@ -2755,10 +3333,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEntity", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEntity" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}": { @@ -2767,7 +3342,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2775,8 +3350,8 @@ "status", "factor_type" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Factor.", @@ -2825,10 +3400,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFactor", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFactor" }, "get": { "description": "Fetch a specific Factor.", @@ -2873,6 +3445,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.factor" + }, + "examples": { + "fetchPush": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchTotp": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2884,10 +3504,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFactor", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFactor" }, "post": { "description": "Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param.", @@ -2932,6 +3549,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.factor" + }, + "examples": { + "verifyPush": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "verified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "verifyTotp": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "verified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2944,9 +3609,6 @@ } ], "operationId": "UpdateFactor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2992,6 +3654,22 @@ "description": "The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.\n\nRequired when `factor_type` is `push`." } } + }, + "examples": { + "verifyPush": { + "value": { + "AuthPayload": "123456", + "FriendlyName": "FriendlyName", + "Config.SdkVersion": "1.0", + "Config.NotificationToken": "test_token" + } + }, + "verifyTotp": { + "value": { + "FriendlyName": "My Friendly Name", + "AuthPayload": "123456" + } + } } } } @@ -3004,7 +3682,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3012,8 +3690,8 @@ "status", "factor_type" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Factors for an Entity.", @@ -3082,16 +3760,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3100,17 +3780,103 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "factors": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "next_page_url": null, + "key": "factors" + } + } + }, + "readFullPush": { + "value": { + "factors": [ + { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "next_page_url": null, + "key": "factors" + } + } + }, + "readFullTotp": { + "value": { + "factors": [ + { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0", + "next_page_url": null, + "key": "factors" } } } @@ -3125,10 +3891,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFactor", - "x-maturity": [ - "GA" - ] + "operationId": "ListFactor" }, "post": { "description": "Create a new Factor for the Entity", @@ -3161,6 +3924,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.new_factor" + }, + "examples": { + "createPush": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "binding": { + "alg": "ES256", + "public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8GdwtibWe0kpgsFl6xPQBwhtwUEyeJkeozFmi2jiJDzxFSMwVy3kVR1h/dPVYOfgkC0EkfBRJ0J/6xW47FD5vA==" + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "push", + "config": { + "sdk_version": "1.0", + "app_id": "com.example.myapp", + "notification_platform": "fcm", + "notification_token": "test_token" + }, + "metadata": { + "os": "Android" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createTotp": { + "value": { + "sid": "YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "binding": { + "secret": "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ", + "uri": "otpauth://totp/test-issuer:John%E2%80%99s%20Account%20Name?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=test-issuer&algorithm=SHA1&digits=6&period=30" + }, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "status": "unverified", + "factor_type": "totp", + "config": { + "alg": "sha1", + "skew": 1, + "code_length": 6, + "time_step": 30 + }, + "metadata": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3173,9 +3992,6 @@ } ], "operationId": "CreateNewFactor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3246,6 +4062,32 @@ "FriendlyName", "FactorType" ] + }, + "examples": { + "createPush": { + "value": { + "FactorType": "push", + "FriendlyName": "FriendlyName", + "Binding.Alg": "ES256", + "Binding.PublicKey": "dGVzdF9rZXk=", + "Config.SdkVersion": "1.0", + "Config.AppId": "com.example.myapp", + "Config.NotificationPlatform": "fcm", + "Config.NotificationToken": "test_token", + "Metadata": "{\"os\": \"Android\"}" + } + }, + "createTotp": { + "value": { + "FactorType": "totp", + "FriendlyName": "FriendlyName", + "Binding.Secret": "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ", + "Config.Alg": "sha1", + "Config.TimeStep": 30, + "Config.CodeLength": 6, + "Config.Skew": 1 + } + } } } } @@ -3261,7 +4103,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "form_type" @@ -3288,6 +4130,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.form" + }, + "examples": { + "fetch": { + "value": { + "form_type": "form-push", + "forms": { + "create_factor": {}, + "verify_factor": {}, + "create_challenge": {} + }, + "form_meta": {}, + "url": "https://verify.twilio.com/v2/Forms/form-push" + } + } } } }, @@ -3299,10 +4155,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchForm", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchForm" } }, "/v2/Services/{ServiceSid}/MessagingConfigurations": { @@ -3311,7 +4164,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3321,8 +4174,8 @@ "date_created", "date_updated" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new MessagingConfiguration for a service.", @@ -3346,6 +4199,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + } } } }, @@ -3358,9 +4224,6 @@ } ], "operationId": "CreateMessagingConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3384,6 +4247,14 @@ "Country", "MessagingServiceSid" ] + }, + "examples": { + "create": { + "value": { + "Country": "CA", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3447,16 +4318,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3465,17 +4338,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "messaging_configurations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "next_page_url": null, + "key": "messaging_configurations" + } + } + }, + "readFull": { + "value": { + "messaging_configurations": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0", + "next_page_url": null, + "key": "messaging_configurations" } } } @@ -3490,10 +4401,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessagingConfiguration" } }, "/v2/Services/{ServiceSid}/MessagingConfigurations/{Country}": { @@ -3502,7 +4410,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3512,8 +4420,8 @@ "date_created", "date_updated" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific MessagingConfiguration", @@ -3546,6 +4454,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + } } } }, @@ -3558,9 +4479,6 @@ } ], "operationId": "UpdateMessagingConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3579,6 +4497,13 @@ "required": [ "MessagingServiceSid" ] + }, + "examples": { + "update": { + "value": { + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3615,6 +4540,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "country": "CA", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA" + } + } } } }, @@ -3626,10 +4564,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessagingConfiguration" }, "delete": { "description": "Delete a specific MessagingConfiguration.", @@ -3666,10 +4601,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessagingConfiguration" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications": { @@ -3678,7 +4610,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3686,8 +4618,8 @@ "challenge_sid", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Notification for the corresponding Challenge", @@ -3732,6 +4664,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.entity.challenge.notification" + }, + "examples": { + "createWithTtl": { + "value": { + "sid": "NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "challenge_sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "priority": "high", + "ttl": 150 + } + }, + "createWithoutTtl": { + "value": { + "sid": "NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "entity_sid": "YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "ff483d1ff591898a9942916050d2ca3f", + "challenge_sid": "YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "priority": "high", + "ttl": 300 + } + } } } }, @@ -3744,9 +4704,6 @@ } ], "operationId": "CreateNotification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3759,8 +4716,18 @@ "description": "How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery." } } - } - } + }, + "examples": { + "createWithTtl": { + "value": { + "Ttl": 150 + } + }, + "createWithoutTtl": { + "value": {} + } + } + } } } } @@ -3771,7 +4738,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3782,11 +4749,11 @@ "date_created", "date_updated" ], - "pathType": "list", "dependentProperties": { "bucket": "{service_sid: service_sid, rate_limit_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Rate Limit for a Service", @@ -3810,6 +4777,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit" + }, + "examples": { + "createRateLimit": { + "value": { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + } } } }, @@ -3822,9 +4806,6 @@ } ], "operationId": "CreateRateLimit", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3844,6 +4825,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "createRateLimit": { + "value": { + "UniqueName": "unique.name", + "Description": "Description" + } + } } } } @@ -3907,16 +4896,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3925,18 +4916,46 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "rate_limits", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0" + }, + "rate_limits": [ + { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + ] } } } @@ -3950,10 +4969,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "ListRateLimit" } }, "/v2/Services/{ServiceSid}/RateLimits/{Sid}": { @@ -3962,7 +4978,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3973,11 +4989,11 @@ "date_created", "date_updated" ], - "pathType": "instance", "dependentProperties": { "bucket": "{service_sid: service_sid, rate_limit_sid: sid}" }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific Rate Limit.", @@ -4013,6 +5029,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit" + }, + "examples": { + "updateRateLimit": { + "value": { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + } } } }, @@ -4025,9 +5058,6 @@ } ], "operationId": "UpdateRateLimit", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4040,6 +5070,13 @@ "description": "Description of this Rate Limit" } } + }, + "examples": { + "updateRateLimit": { + "value": { + "Description": "Description" + } + } } } } @@ -4079,6 +5116,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.rate_limit" + }, + "examples": { + "fetchRateLimit": { + "value": { + "sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique.name", + "description": "Description", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "buckets": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets" + } + } + } } } }, @@ -4090,10 +5144,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRateLimit" }, "delete": { "description": "Delete a specific Rate Limit.", @@ -4133,10 +5184,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRateLimit" } }, "/v2/SafeList/Numbers": { @@ -4145,14 +5193,14 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "phone_number" ], - "pathType": "list", - "mountName": "safelist" + "mountName": "safelist", + "pathType": "list" }, "post": { "description": "Add a new phone number to SafeList.", @@ -4162,6 +5210,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.safelist" + }, + "examples": { + "create": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567", + "url": "https://verify.twilio.com/v2/SafeList/Numbers/+18001234567" + } + } } } }, @@ -4174,9 +5231,6 @@ } ], "operationId": "CreateSafelist", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4192,6 +5246,13 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumber": "+18001234567" + } + } } } } @@ -4204,14 +5265,14 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "phone_number" ], - "pathType": "instance", - "mountName": "safelist" + "mountName": "safelist", + "pathType": "instance" }, "get": { "description": "Check if a phone number exists in SafeList.", @@ -4232,6 +5293,15 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.safelist" + }, + "examples": { + "fetch": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567", + "url": "https://verify.twilio.com/v2/SafeList/Numbers/+18001234567" + } + } } } }, @@ -4243,10 +5313,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSafelist" }, "delete": { "description": "Remove a phone number from SafeList.", @@ -4271,10 +5338,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSafelist" } }, "/v2/Services": { @@ -4283,14 +5347,13 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "verification": "{service_sid: sid}", "verification_check": "{service_sid: sid}", @@ -4299,7 +5362,8 @@ "entity": "{service_sid: sid}", "webhook": "{service_sid: sid}", "access_token": "{service_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "Create a new Verification Service.", @@ -4309,6 +5373,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service" + }, + "examples": { + "createRecord": { + "value": { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fcm_credential_sid": null + }, + "totp": { + "issuer": "test-issuer", + "time_step": 30, + "code_length": 3, + "skew": 2 + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "verification_checks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck", + "verifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications", + "rate_limits": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits", + "messaging_configurations": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations", + "entities": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities", + "webhooks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "access_tokens": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens" + } + } + } } } }, @@ -4321,9 +5427,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4412,6 +5515,28 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "createRecord": { + "value": { + "FriendlyName": "name", + "CodeLength": 4, + "LookupEnabled": false, + "Psd2Enabled": false, + "SkipSmsToLandlines": false, + "DtmfInputRequired": false, + "TtsName": "name", + "MailerSid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DoNotShareWarningEnabled": false, + "CustomCodeEnabled": true, + "Push.ApnCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Totp.Issuer": "test-issuer", + "Totp.TimeStep": 30, + "Totp.CodeLength": 3, + "Totp.Skew": 2, + "DefaultTemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4463,16 +5588,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4481,18 +5608,71 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readAll": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services?PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "services", + "url": "https://verify.twilio.com/v2/Services?PageSize=50&Page=0" + }, + "services": [ + { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": null, + "fcm_credential_sid": null + }, + "totp": { + "issuer": null, + "time_step": null, + "code_length": null, + "skew": null + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "verification_checks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck", + "verifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications", + "rate_limits": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits", + "messaging_configurations": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations", + "entities": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities", + "webhooks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "access_tokens": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens" + } + } + ] } } } @@ -4506,10 +5686,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{Sid}": { @@ -4518,14 +5695,13 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "verification": "{service_sid: sid}", "verification_check": "{service_sid: sid}", @@ -4534,7 +5710,8 @@ "entity": "{service_sid: sid}", "webhook": "{service_sid: sid}", "access_token": "{service_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch specific Verification Service Instance.", @@ -4558,6 +5735,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service" + }, + "examples": { + "fetchRecord": { + "value": { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": null, + "fcm_credential_sid": null + }, + "totp": { + "issuer": null, + "time_step": null, + "code_length": null, + "skew": null + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "verification_checks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck", + "verifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications", + "rate_limits": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits", + "messaging_configurations": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations", + "entities": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities", + "webhooks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "access_tokens": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens" + } + } + } } } }, @@ -4569,10 +5788,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a specific Verification Service Instance.", @@ -4600,10 +5816,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Verification Service.", @@ -4627,6 +5840,48 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service" + }, + "examples": { + "updateRecord": { + "value": { + "sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "code_length": 4, + "lookup_enabled": false, + "psd2_enabled": false, + "skip_sms_to_landlines": false, + "dtmf_input_required": false, + "tts_name": "name", + "mailer_sid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "do_not_share_warning_enabled": false, + "custom_code_enabled": true, + "push": { + "include_date": false, + "apn_credential_sid": null, + "fcm_credential_sid": "CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + }, + "totp": { + "issuer": "test-issuer", + "time_step": 30, + "code_length": 3, + "skew": 2 + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "verification_checks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck", + "verifications": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications", + "rate_limits": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits", + "messaging_configurations": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations", + "entities": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities", + "webhooks": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", + "access_tokens": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens" + } + } + } } } }, @@ -4639,9 +5894,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4727,6 +5979,29 @@ "description": "The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only." } } + }, + "examples": { + "updateRecord": { + "value": { + "FriendlyName": "name", + "CodeLength": 4, + "LookupEnabled": false, + "Psd2Enabled": false, + "SkipSmsToLandlines": false, + "DtmfInputRequired": false, + "TtsName": "name", + "MailerSid": "MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DoNotShareWarningEnabled": false, + "CustomCodeEnabled": true, + "Push.IncludeDate": false, + "Push.FcmCredentialSid": "CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "Totp.Issuer": "test-issuer", + "Totp.TimeStep": 30, + "Totp.CodeLength": 3, + "Totp.Skew": 2, + "DefaultTemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4739,7 +6014,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4749,8 +6024,8 @@ "valid", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Verification using a Service", @@ -4774,6 +6049,178 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification" + }, + "examples": { + "createVerification": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationWhatsapp": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "whatsapp", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "whatsapp", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationEmail": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "mail@email.com", + "channel": "email", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "EMAIL", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationWithRateLimits": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationSna": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sna", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": { + "carrier": { + "mobile_country_code": "311", + "type": "mobile", + "error_code": null, + "mobile_network_code": "180", + "name": "T-Mobile USA, Inc." + } + }, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "sna", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": { + "url": "https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createVerificationAuto": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sna", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": { + "carrier": { + "mobile_country_code": "311", + "type": "mobile", + "error_code": null, + "mobile_network_code": "180", + "name": "T-Mobile USA, Inc." + } + }, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "sna", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": { + "url": "https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs" + }, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4786,9 +6233,6 @@ } ], "operationId": "CreateVerification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4862,6 +6306,69 @@ "To", "Channel" ] + }, + "examples": { + "createVerification": { + "value": { + "To": "+15017122661", + "Channel": "sms", + "CustomCode": "custom_code", + "CustomFriendlyName": "custom_friendly_name", + "CustomMessage": "custom_message", + "SendDigits": "ww1", + "Locale": "en", + "Amount": "\u20ac39.99", + "Payee": "Acme Inc.", + "AppHash": "AAAAAAAAAAA", + "TemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TemplateCustomSubstitutions": "{\"AppName\": \"MyApp\", \"Contact\":\"12345689\"}" + } + }, + "createVerificationWhatsapp": { + "value": { + "To": "+15017122661", + "Channel": "whatsapp", + "CustomCode": "custom_code", + "CustomFriendlyName": "custom_friendly_name", + "Locale": "en" + } + }, + "createVerificationEmail": { + "value": { + "To": "mail@email.com", + "Channel": "email", + "CustomCode": "custom_code", + "CustomMessage": "custom_message", + "Locale": "en", + "Amount": "\u20ac39.99", + "Payee": "Acme Inc.", + "ChannelConfiguration": "{\"from\": \"foo@bar.com\", \"from_name\": \"Bar Inc.\", \"substitutions\": { \"username\": \"ms. baz\" }, \"template_id\": \"Dxxxxxxxxxx\"}" + } + }, + "createVerificationWithRateLimits": { + "value": { + "To": "+15017122661", + "Channel": "sms", + "CustomCode": "custom_code", + "CustomMessage": "custom_message", + "SendDigits": "ww1", + "Locale": "en", + "RateLimits": "{\"my_rate_limit_key\": \"abc\"}" + } + }, + "createVerificationSna": { + "value": { + "To": "+15017122661", + "Channel": "sna" + } + }, + "createVerificationAuto": { + "value": { + "To": "+15017122661", + "Channel": "auto", + "DeviceIp": "0.000.00.000" + } + } } } } @@ -4874,7 +6381,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4884,8 +6391,8 @@ "valid", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a Verification status", @@ -4918,6 +6425,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification" + }, + "examples": { + "updateVerification": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "canceled", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "approveVerificationWithPn": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "approved", + "valid": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4930,9 +6489,6 @@ } ], "operationId": "UpdateVerification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4949,6 +6505,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateVerification": { + "value": { + "Status": "canceled" + } + }, + "approveVerificationWithPn": { + "value": { + "Status": "approved" + } + } } } } @@ -4985,6 +6553,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification" + }, + "examples": { + "fetchVerification": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "pending", + "valid": false, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "lookup": {}, + "amount": null, + "payee": null, + "send_code_attempts": [ + { + "time": "2015-07-30T20:00:00Z", + "channel": "SMS", + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "sna": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -4996,10 +6591,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerification" } }, "/v2/Attempts": { @@ -5008,7 +6600,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5017,8 +6609,8 @@ "conversion_status", "channel" ], - "pathType": "list", - "mountName": "verification_attempts" + "mountName": "verification_attempts", + "pathType": "list" }, "get": { "description": "List all the verification attempts for a given Account.", @@ -5141,16 +6733,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5159,17 +6753,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "listVerificationAttemptsEmpty": { + "value": { + "attempts": [], + "meta": { + "key": "attempts", + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "next_page_url": null + } + } + }, + "listVerificationAttempts": { + "value": { + "attempts": [ + { + "sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-08-11T18:36:59Z", + "date_updated": "2020-08-11T18:37:00Z", + "conversion_status": "unconverted", + "channel": "sms", + "price": { + "value": "0.005", + "currency": "usd" + }, + "channel_data": { + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+573003003030", + "status": "unconfirmed", + "message_status": "undelivered", + "error_code": "30008", + "country": "CO", + "code_length": 6, + "locale": "es", + "mcc": "732", + "mnc": "103", + "carrier": "Colombia Movil (Tigo)" + }, + "url": "https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "key": "attempts", + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0", + "next_page_url": null } } } @@ -5184,10 +6835,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVerificationAttempt", - "x-maturity": [ - "GA" - ] + "operationId": "ListVerificationAttempt" } }, "/v2/Attempts/{Sid}": { @@ -5196,7 +6844,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5205,8 +6853,8 @@ "conversion_status", "channel" ], - "pathType": "instance", - "mountName": "verification_attempts" + "mountName": "verification_attempts", + "pathType": "instance" }, "get": { "description": "Fetch a specific verification attempt.", @@ -5230,6 +6878,38 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.verification_attempt" + }, + "examples": { + "fetchVerificationAttempt": { + "value": { + "sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-08-11T18:36:59Z", + "date_updated": "2020-08-11T18:37:00Z", + "conversion_status": "unconverted", + "channel": "sms", + "price": { + "value": "0.005", + "currency": "usd" + }, + "channel_data": { + "verification_sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+573003003030", + "status": "unconfirmed", + "message_status": "undelivered", + "error_code": "30008", + "country": "CO", + "code_length": 6, + "locale": "es", + "mcc": "732", + "mnc": "103", + "carrier": "Colombia Movil (Tigo)" + }, + "url": "https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -5241,10 +6921,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerificationAttempt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerificationAttempt" } }, "/v2/Attempts/Summary": { @@ -5253,7 +6930,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "total_attempts", @@ -5261,8 +6938,8 @@ "total_unconverted", "conversion_rate_percentage" ], - "pathType": "instance", - "mountName": "verification_attempts_summary" + "mountName": "verification_attempts_summary", + "pathType": "instance" }, "get": { "description": "Get a summary of how many attempts were made and how many were converted.", @@ -5276,6 +6953,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$" + }, + "examples": { + "getAttemptsSummary": { + "value": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -5285,6 +6967,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "getAttemptsSummary": { + "value": "2022-03-02T21:02:33Z" + } } }, { @@ -5294,6 +6981,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "getAttemptsSummary": { + "value": "2022-03-02T21:02:33Z" + } } }, { @@ -5303,6 +6995,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "getAttemptsSummary": { + "value": "CO" + } } }, { @@ -5312,6 +7009,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/verification_attempts_summary_enum_channels" + }, + "examples": { + "getAttemptsSummary": { + "value": "sms" + } } }, { @@ -5320,6 +7022,11 @@ "description": "Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.", "schema": { "type": "string" + }, + "examples": { + "getAttemptsSummary": { + "value": "+57305" + } } } ], @@ -5329,6 +7036,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.verification_attempts_summary" + }, + "examples": { + "getAttemptsSummary": { + "value": { + "total_attempts": 11, + "total_converted": 9, + "total_unconverted": 2, + "conversion_rate_percentage": "81.818181818", + "url": "https://verify.twilio.com/v2/Attempts/Summary" + } + } } } }, @@ -5340,10 +7058,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerificationAttemptsSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerificationAttemptsSummary" } }, "/v2/Services/{ServiceSid}/VerificationCheck": { @@ -5352,7 +7067,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5362,9 +7077,9 @@ "valid", "date_created" ], - "pathType": "list", "parent": "/Services/{Sid}", - "mountName": "verification_checks" + "mountName": "verification_checks", + "pathType": "list" }, "post": { "description": "challenge a specific Verification Check.", @@ -5388,6 +7103,61 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.verification_check" + }, + "examples": { + "verificationChecks": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sms", + "status": "approved", + "valid": true, + "amount": null, + "payee": null, + "sna_attempts_error_codes": [], + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + }, + "emailVerificationChecks": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "recipient@foo.com", + "channel": "email", + "status": "approved", + "valid": true, + "amount": null, + "payee": null, + "sna_attempts_error_codes": [], + "date_created": "2020-01-30T20:00:00Z", + "date_updated": "2020-01-30T20:00:00Z" + } + }, + "snaVerificationChecks": { + "value": { + "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "to": "+15017122661", + "channel": "sna", + "status": "approved", + "valid": true, + "amount": null, + "payee": null, + "sna_attempts_error_codes": [ + { + "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "code": 60001 + } + ], + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5400,9 +7170,6 @@ } ], "operationId": "CreateVerificationCheck", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5434,6 +7201,29 @@ "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." } } + }, + "examples": { + "verificationChecks": { + "value": { + "To": "+15017122661", + "VerificationSid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Code": "1234", + "Amount": "\u20ac39.99", + "Payee": "Acme Inc." + } + }, + "emailVerificationChecks": { + "value": { + "To": "recipient@foo.com", + "VerificationSid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Code": "123456" + } + }, + "snaVerificationChecks": { + "value": { + "To": "+15017122661" + } + } } } } @@ -5446,7 +7236,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5508,16 +7298,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5526,17 +7318,69 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "listVerificationTemplates": { + "value": { + "templates": [ + { + "sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Base Verification Template 2 with do not share", + "channels": [ + "sms" + ], + "translations": { + "en": { + "is_default_translation": true, + "status": "approved", + "locale": "en", + "text": "Your {{friendly_name}} verification code is: {{code}}. Do not share this code with anyone.", + "date_updated": "2021-07-29T20:38:28.759979905Z", + "date_created": "2021-07-29T20:38:28.165602325Z" + } + } + }, + { + "sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Base Verification Template 3", + "channels": [ + "sms", + "voice" + ], + "translations": { + "en": { + "is_default_translation": true, + "status": "approved", + "locale": "en", + "text": "Your verification code is: {{code}}. Do not share it.", + "date_updated": "2021-07-29T20:38:28.759979905Z", + "date_created": "2021-07-29T20:38:28.165602325Z" + } + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Templates?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Templates?PageSize=50&Page=0", + "next_page_url": null, + "key": "templates" } } } @@ -5551,10 +7395,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVerificationTemplate", - "x-maturity": [ - "GA" - ] + "operationId": "ListVerificationTemplate" } }, "/v2/Services/{ServiceSid}/Webhooks": { @@ -5563,7 +7404,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5575,8 +7416,8 @@ "status", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Webhook for the Service", @@ -5600,6 +7441,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.webhook" + }, + "examples": { + "create": { + "value": { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "enabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5612,9 +7474,6 @@ } ], "operationId": "CreateWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5653,6 +7512,19 @@ "EventTypes", "WebhookUrl" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "name", + "EventTypes": [ + "factor.deleted", + "factor.verified" + ], + "WebhookUrl": "https://owlbank.twilio.com", + "Version": "v2" + } + } } } } @@ -5716,16 +7588,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5734,17 +7608,63 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "webhooks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "next_page_url": null, + "key": "webhooks" + } + } + }, + "readFull": { + "value": { + "webhooks": [ + { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "enabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", + "next_page_url": null, + "key": "webhooks" } } } @@ -5759,10 +7679,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListWebhook" } }, "/v2/Services/{ServiceSid}/Webhooks/{Sid}": { @@ -5771,7 +7688,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5783,8 +7700,8 @@ "status", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "", @@ -5820,6 +7737,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.webhook" + }, + "examples": { + "update": { + "value": { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "disabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5832,9 +7770,6 @@ } ], "operationId": "UpdateWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5868,6 +7803,20 @@ "description": "The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "name", + "EventTypes": [ + "factor.deleted", + "factor.verified" + ], + "WebhookUrl": "https://owlbank.twilio.com", + "Status": "disabled", + "Version": "v2" + } + } } } } @@ -5911,10 +7860,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWebhook" }, "get": { "description": "Fetch a specific Webhook.", @@ -5950,6 +7896,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/verify.v2.service.webhook" + }, + "examples": { + "fetch": { + "value": { + "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "name", + "event_types": [ + "factor.deleted", + "factor.verified" + ], + "webhook_method": "POST", + "webhook_url": "https://owlbank.twilio.com", + "status": "enabled", + "version": "v2", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z" + } + } } } }, @@ -5961,10 +7928,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWebhook" } } }, @@ -5972,15 +7936,5 @@ { "url": "https://verify.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 3923496e..dec89871 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "video.v1.composition": { "type": "object", @@ -1297,12 +1303,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1318,7 +1318,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1336,10 +1336,10 @@ "resolution", "format" ], - "pathType": "instance", "dependentProperties": { - "video/v1/composition_media": "{composition_sid: sid}" - } + "media": "{composition_sid: sid}" + }, + "pathType": "instance" }, "get": { "description": "Returns a single Composition resource identified by a Composition SID.", @@ -1363,6 +1363,74 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_completed": "2015-07-30T20:01:33Z", + "date_deleted": null, + "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "audio_sources_excluded": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "video_layout": { + "grid": { + "video_sources": [ + "*" + ], + "video_sources_excluded": [ + "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "bitrate": 64, + "size": 4, + "duration": 6, + "trim": true, + "media_external_location": null, + "encryption_key": null, + "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "links": { + "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -1374,10 +1442,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchComposition", - "x-maturity": [ - "GA" - ] + "operationId": "FetchComposition" }, "delete": { "description": "Delete a Recording Composition resource identified by a Composition SID.", @@ -1405,10 +1470,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteComposition", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteComposition" } }, "/v1/Compositions": { @@ -1425,10 +1487,10 @@ "resolution", "format" ], - "pathType": "list", "dependentProperties": { - "video/v1/composition_media": "{composition_sid: sid}" - } + "media": "{composition_sid: sid}" + }, + "pathType": "list" }, "get": { "description": "List of all Recording compositions.", @@ -1440,6 +1502,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/composition_enum_status" + }, + "examples": { + "readEnqueued": { + "value": "enqueued" + }, + "readEmpty": { + "value": "completed" + }, + "readResults": { + "value": "completed" + } } }, { @@ -1449,6 +1522,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -1458,6 +1536,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -1469,6 +1552,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" + }, + "examples": { + "readResults": { + "value": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1514,16 +1602,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1532,17 +1622,120 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEnqueued": { + "value": { + "compositions": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0", + "next_page_url": null, + "key": "compositions" + } + } + }, + "readEmpty": { + "value": { + "compositions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0", + "next_page_url": null, + "key": "compositions" + } + } + }, + "readResults": { + "value": { + "compositions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_completed": "2015-07-30T20:01:33Z", + "date_deleted": null, + "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "audio_sources_excluded": [], + "video_layout": { + "grid": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "bitrate": 64, + "size": 4, + "duration": 6, + "trim": true, + "media_external_location": null, + "encryption_key": null, + "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "links": { + "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0", + "next_page_url": null, + "key": "compositions" } } } @@ -1557,10 +1750,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListComposition", - "x-maturity": [ - "GA" - ] + "operationId": "ListComposition" }, "post": { "description": "", @@ -1570,6 +1760,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "processing", + "date_created": "2015-07-30T20:00:00Z", + "date_completed": null, + "date_deleted": null, + "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "audio_sources_excluded": [ + "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "video_layout": { + "custom": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [ + "RTcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 800, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [ + 2, + 3 + ] + } + }, + "trim": true, + "format": "mp4", + "resolution": "1920x1080", + "bitrate": 0, + "size": 0, + "duration": 0, + "media_external_location": null, + "encryption_key": null, + "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "links": { + "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -1582,9 +1828,6 @@ } ], "operationId": "CreateComposition", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1651,6 +1894,24 @@ "required": [ "RoomSid" ] + }, + "examples": { + "create": { + "value": { + "RoomSid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AudioSources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "AudioSourcesExcluded": [ + "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "VideoLayout": "{}", + "Trim": true, + "Format": "mp4", + "Resolution": "1920x1080" + } + } } } } @@ -1694,6 +1955,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My composition hook", + "enabled": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*" + ], + "audio_sources_excluded": [ + "moderator*" + ], + "video_layout": { + "grid": { + "video_sources": [ + "*" + ], + "video_sources_excluded": [ + "moderator*" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "student*" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "trim": true, + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1705,10 +2024,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCompositionHook" }, "delete": { "description": "Delete a Recording CompositionHook resource identified by a `CompositionHook SID`.", @@ -1736,10 +2052,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCompositionHook" }, "post": { "description": "", @@ -1763,6 +2076,77 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" + }, + "examples": { + "updateAllFields": { + "value": { + "friendly_name": "My composition hook", + "enabled": true, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*", + "moderator" + ], + "audio_sources_excluded": [ + "admin" + ], + "video_layout": { + "custom": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [ + "moderator" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 800, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [ + 2, + 3 + ] + } + }, + "trim": true, + "format": "mp4", + "resolution": "1280x720", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateWithDefaults": { + "value": { + "friendly_name": "My composition hook", + "enabled": true, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*", + "moderator" + ], + "audio_sources_excluded": [ + "admin" + ], + "video_layout": {}, + "trim": true, + "format": "mp4", + "resolution": "1280x720", + "status_callback": null, + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1775,9 +2159,6 @@ } ], "operationId": "UpdateCompositionHook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1845,6 +2226,41 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "updateAllFields": { + "value": { + "FriendlyName": "My composition hook", + "Enabled": true, + "AudioSources": [ + "user*", + "moderator" + ], + "AudioSourcesExcluded": [ + "admin" + ], + "VideoLayout": "{}", + "Trim": true, + "Format": "mp4", + "Resolution": "1280x720", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "POST" + } + }, + "updateWithDefaults": { + "value": { + "FriendlyName": "My composition hook", + "AudioSources": [ + "user*", + "moderator" + ], + "AudioSourcesExcluded": [ + "admin" + ], + "Format": "mp4", + "Resolution": "1280x720" + } + } } } } @@ -1875,6 +2291,14 @@ "description": "Read only CompositionHook resources with an `enabled` value that matches this parameter.", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + }, + "readResults": { + "value": true + } } }, { @@ -1884,6 +2308,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -1893,6 +2322,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -1901,6 +2335,11 @@ "description": "Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk `*` characters as wildcard match.", "schema": { "type": "string" + }, + "examples": { + "readResults": { + "value": "*Hook*" + } } }, { @@ -1946,16 +2385,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1964,17 +2405,98 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "composition_hooks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0", + "next_page_url": null, + "key": "composition_hooks" + } + } + }, + "readResults": { + "value": { + "composition_hooks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My Special Hook1", + "enabled": true, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:01:33Z", + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "*" + ], + "audio_sources_excluded": [], + "video_layout": { + "grid": { + "video_sources": [ + "*" + ], + "video_sources_excluded": [ + "moderator*" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + }, + "pip": { + "video_sources": [ + "student*" + ], + "video_sources_excluded": [], + "reuse": "none", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 0, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [] + } + }, + "resolution": "1280x720", + "format": "webm", + "trim": true, + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0", + "next_page_url": null, + "key": "composition_hooks" } } } @@ -1989,10 +2511,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "ListCompositionHook" }, "post": { "description": "", @@ -2002,6 +2521,53 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" + }, + "examples": { + "create": { + "value": { + "friendly_name": "My composition hook", + "enabled": false, + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": null, + "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "audio_sources": [ + "user*", + "moderator" + ], + "audio_sources_excluded": [ + "admin" + ], + "video_layout": { + "custom": { + "video_sources": [ + "user*" + ], + "video_sources_excluded": [ + "moderator" + ], + "reuse": "show_oldest", + "x_pos": 100, + "y_pos": 600, + "z_pos": 10, + "width": 800, + "height": 0, + "max_columns": 0, + "max_rows": 0, + "cells_excluded": [ + 2, + 3 + ] + } + }, + "trim": true, + "format": "mp4", + "resolution": "1280x720", + "status_callback": "http://www.example.com", + "status_callback_method": "POST", + "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2014,9 +2580,6 @@ } ], "operationId": "CreateCompositionHook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2084,6 +2647,27 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "My composition hook", + "Enabled": false, + "AudioSources": [ + "user*", + "moderator" + ], + "AudioSourcesExcluded": [ + "admin" + ], + "VideoLayout": "{}", + "Trim": true, + "Format": "mp4", + "Resolution": "1280x720", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "POST" + } + } } } } @@ -2103,9 +2687,9 @@ "aws_storage_enabled", "encryption_enabled" ], - "pathType": "instance", "mountName": "composition_settings", - "className": "composition_settings" + "className": "composition_settings", + "pathType": "instance" }, "get": { "description": "", @@ -2115,6 +2699,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_settings" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "string", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/CompositionSettings/Default" + } + } } } }, @@ -2126,10 +2724,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCompositionSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCompositionSettings" }, "post": { "description": "", @@ -2139,6 +2734,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_settings" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/CompositionSettings/Default" + } + } } } }, @@ -2151,9 +2760,6 @@ } ], "operationId": "CreateCompositionSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2196,6 +2802,18 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "AwsStorageEnabled": true, + "EncryptionEnabled": true + } + } } } } @@ -2218,10 +2836,10 @@ "duration", "codec" ], - "pathType": "instance", "dependentProperties": { - "video/v1/recording_media": "{recording_sid: sid}" - } + "media": "{recording_sid: sid}" + }, + "pathType": "instance" }, "get": { "description": "Returns a single Recording resource identified by a Recording SID.", @@ -2245,6 +2863,37 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "processing", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 0, + "url": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "audio", + "duration": 0, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "links": { + "media": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -2256,10 +2905,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "delete": { "description": "Delete a Recording resource identified by a Recording SID.", @@ -2287,10 +2933,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecording" } }, "/v1/Recordings": { @@ -2309,10 +2952,10 @@ "duration", "codec" ], - "pathType": "list", "dependentProperties": { - "video/v1/recording_media": "{recording_sid: sid}" - } + "media": "{recording_sid: sid}" + }, + "pathType": "list" }, "get": { "description": "List of all Track recordings.", @@ -2324,6 +2967,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/recording_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + }, + "readResults": { + "value": "completed" + } } }, { @@ -2335,6 +2986,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "source_sid" + }, + "readResults": { + "value": "source_sid" + } } }, { @@ -2349,6 +3008,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "readResults": { + "value": [ + "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } } }, { @@ -2358,6 +3030,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -2367,6 +3044,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -2376,6 +3058,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/recording_enum_type" + }, + "examples": { + "readEmpty": { + "value": "audio" + }, + "readResults": { + "value": "audio" + } } }, { @@ -2421,16 +3111,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2439,17 +3131,74 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "recordings": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" + } + } + }, + "readResults": { + "value": { + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 23, + "type": "audio", + "duration": 10, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "status_callback": "https://mycallbackurl.com", + "status_callback_method": "POST", + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "url": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "media": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" } } } @@ -2464,10 +3213,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecording" } }, "/v1/RecordingSettings/Default": { @@ -2483,9 +3229,9 @@ "aws_storage_enabled", "encryption_enabled" ], - "pathType": "instance", "mountName": "recording_settings", - "className": "recording_settings" + "className": "recording_settings", + "pathType": "instance" }, "get": { "description": "", @@ -2495,6 +3241,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording_settings" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "string", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/RecordingSettings/Default" + } + } } } }, @@ -2506,10 +3266,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingSettings" }, "post": { "description": "", @@ -2519,6 +3276,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording_settings" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "aws_storage_enabled": true, + "encryption_enabled": true, + "url": "https://video.twilio.com/v1/RecordingSettings/Default" + } + } } } }, @@ -2531,9 +3302,6 @@ } ], "operationId": "CreateRecordingSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2576,6 +3344,18 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "AwsStorageEnabled": true, + "EncryptionEnabled": true + } + } } } } @@ -2595,12 +3375,12 @@ "unique_name", "status" ], - "pathType": "instance", "dependentProperties": { "room_recording": "{room_sid: sid}", "participant": "{room_sid: sid}", "recording_rules": "{room_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -2621,6 +3401,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "peer-to-peer", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "unique_name", + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 0, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "audio_only": false, + "media_region": "us1", + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + } } } }, @@ -2632,10 +3448,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoom", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoom" }, "post": { "description": "", @@ -2656,6 +3469,42 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "completed", + "type": "peer-to-peer", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "unique_name", + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 10, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "duration": 10, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + } } } }, @@ -2668,9 +3517,6 @@ } ], "operationId": "UpdateRoom", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2687,6 +3533,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "completed" + } + } } } } @@ -2706,12 +3559,12 @@ "unique_name", "status" ], - "pathType": "list", "dependentProperties": { "room_recording": "{room_sid: sid}", "participant": "{room_sid: sid}", "recording_rules": "{room_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -2721,6 +3574,242 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "peer-to-peer", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "max_concurrent_published_tracks": 0, + "max_participants": 10, + "max_participant_duration": 86400, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createWebrtcGo": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "go", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "room1", + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 0, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createGroupRooms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "grouproom", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 170, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createGroupRoomsWithAudioOnlyEnabled": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "grouproom", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 170, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [], + "media_region": "us1", + "audio_only": true, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createSmallGroupRooms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group-small", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "SmallDailyStandup", + "max_participants": 4, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 170, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createLargeGroupRooms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "MyWebinar", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 16, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + }, + "createLargeGroupRoomsWithAudioOnlyEnabled": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "status": "in-progress", + "type": "group", + "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enable_turn": true, + "unique_name": "MyWebinar", + "max_participants": 50, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 16, + "duration": 0, + "status_callback_method": "POST", + "status_callback": null, + "record_participants_on_connect": false, + "video_codecs": [], + "media_region": "us1", + "audio_only": true, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "end_time": "2015-07-30T20:00:00Z", + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" + } + } + } } } }, @@ -2733,9 +3822,6 @@ } ], "operationId": "CreateRoom", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2818,6 +3904,53 @@ "description": "When set to true, indicated that this is the large room." } } + }, + "examples": { + "create": { + "value": {} + }, + "createWebrtcGo": { + "value": { + "Type": "go", + "UniqueName": "room1" + } + }, + "createGroupRooms": { + "value": { + "Type": "group", + "UniqueName": "grouproom", + "RecordingRules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" + } + }, + "createGroupRoomsWithAudioOnlyEnabled": { + "value": { + "Type": "group", + "UniqueName": "grouproom", + "RecordingRules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D", + "AudioOnly": true + } + }, + "createSmallGroupRooms": { + "value": { + "Type": "group-small", + "UniqueName": "SmallDailyStandup" + } + }, + "createLargeGroupRooms": { + "value": { + "Type": "group", + "UniqueName": "MyWebinar", + "MaxParticipants": 90 + } + }, + "createLargeGroupRoomsWithAudioOnlyEnabled": { + "value": { + "Type": "group", + "UniqueName": "MyWebinar", + "MaxParticipants": 90, + "AudioOnly": true + } + } } } } @@ -2833,6 +3966,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_enum_room_status" + }, + "examples": { + "readWithStatus": { + "value": "completed" + } } }, { @@ -2904,16 +4042,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2922,17 +4062,78 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "rooms": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms?PageSize=50&Page=0", + "next_page_url": null, + "key": "rooms" + } + } + }, + "readWithStatus": { + "value": { + "rooms": [ + { + "sid": "RM4070b618362c1682b2385b1f9982833c", + "status": "completed", + "date_created": "2017-04-03T22:21:49Z", + "date_updated": "2017-04-03T22:21:51Z", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "peer-to-peer", + "enable_turn": true, + "unique_name": "RM4070b618362c1682b2385b1f9982833c", + "status_callback": null, + "status_callback_method": "POST", + "end_time": "2017-04-03T22:21:51Z", + "duration": 2, + "max_participants": 10, + "max_participant_duration": 86400, + "max_concurrent_published_tracks": 10, + "record_participants_on_connect": false, + "video_codecs": [ + "VP8" + ], + "media_region": "us1", + "audio_only": false, + "empty_room_timeout": 5, + "unused_room_timeout": 5, + "large_room": false, + "url": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c", + "links": { + "participants": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Participants", + "recordings": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Recordings", + "recording_rules": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/RecordingRules" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0", + "next_page_url": null, + "key": "rooms" } } } @@ -2947,10 +4148,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoom", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoom" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}": { @@ -2966,14 +4164,14 @@ "identity", "status" ], - "pathType": "instance", "dependentProperties": { "published_track": "{room_sid: room_sid, participant_sid: sid}", "subscribed_track": "{room_sid: room_sid, participant_sid: sid}", "subscribe_rules": "{room_sid: room_sid, participant_sid: sid}", "anonymize": "{room_sid: room_sid, sid: sid}" }, - "parent": "/Rooms/{Sid}" + "parent": "/Rooms/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3003,6 +4201,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "start_time": "2015-07-30T20:00:00Z", + "end_time": null, + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob", + "status": "connected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "duration": null, + "links": { + "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", + "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", + "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", + "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" + } + } + } } } }, @@ -3014,10 +4235,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipant" }, "post": { "description": "", @@ -3047,6 +4265,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-30T20:00:00Z", + "date_updated": "2017-07-30T20:00:00Z", + "start_time": "2017-07-30T20:00:00Z", + "end_time": "2017-07-30T20:00:01Z", + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "alice", + "status": "disconnected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "duration": 1, + "links": { + "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", + "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", + "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", + "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" + } + } + } } } }, @@ -3059,9 +4300,6 @@ } ], "operationId": "UpdateRoomParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3075,6 +4313,13 @@ "description": "The new status of the resource. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned." } } + }, + "examples": { + "update": { + "value": { + "Status": "disconnected" + } + } } } } @@ -3094,14 +4339,14 @@ "identity", "status" ], - "pathType": "list", "dependentProperties": { "published_track": "{room_sid: room_sid, participant_sid: sid}", "subscribed_track": "{room_sid: room_sid, participant_sid: sid}", "subscribe_rules": "{room_sid: room_sid, participant_sid: sid}", "anonymize": "{room_sid: room_sid, sid: sid}" }, - "parent": "/Rooms/{Sid}" + "parent": "/Rooms/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3122,6 +4367,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_participant_enum_status" + }, + "examples": { + "readFilters": { + "value": "disconnected" + } } }, { @@ -3130,6 +4380,11 @@ "description": "Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value.", "schema": { "type": "string" + }, + "examples": { + "readFilters": { + "value": "alice" + } } }, { @@ -3139,6 +4394,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFilters": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -3148,6 +4408,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFilters": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -3193,16 +4458,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3211,17 +4478,65 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "participants": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" + } + } + }, + "readFilters": { + "value": { + "participants": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2017-07-30T20:00:00Z", + "date_updated": "2017-07-30T20:00:00Z", + "start_time": "2017-07-30T20:00:00Z", + "end_time": "2017-07-30T20:00:01Z", + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "alice", + "status": "disconnected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "duration": 1, + "links": { + "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", + "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", + "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", + "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0", + "next_page_url": null, + "key": "participants" } } } @@ -3236,10 +4551,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipant" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize": { @@ -3248,15 +4560,15 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "status" ], - "pathType": "instance", - "parent": "/Rooms/{RoomSid}/Participants/{Sid}" + "parent": "/Rooms/{RoomSid}/Participants/{Sid}", + "pathType": "instance" }, "post": { "description": "", @@ -3286,6 +4598,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_anonymize" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "start_time": "2015-07-30T20:00:00Z", + "end_time": null, + "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "disconnected", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize", + "duration": 1 + } + } } } }, @@ -3297,10 +4626,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateRoomParticipantAnonymize", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateRoomParticipantAnonymize" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}": { @@ -3309,7 +4635,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3317,8 +4643,8 @@ "enabled", "kind" ], - "pathType": "instance", - "parent": "/Rooms/{RoomSid}/Participants/{Sid}" + "parent": "/Rooms/{RoomSid}/Participants/{Sid}", + "pathType": "instance" }, "get": { "description": "Returns a single Track resource represented by TrackName or SID.", @@ -3357,6 +4683,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_published_track" + }, + "examples": { + "fetch": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "bob-track", + "kind": "data", + "enabled": true, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3368,10 +4709,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantPublishedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks": { @@ -3380,7 +4718,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3388,8 +4726,8 @@ "enabled", "kind" ], - "pathType": "list", - "parent": "/Rooms/{RoomSid}/Participants/{Sid}" + "parent": "/Rooms/{RoomSid}/Participants/{Sid}", + "pathType": "list" }, "get": { "description": "Returns a list of tracks associated with a given Participant. Only `currently` Published Tracks are in the list resource.", @@ -3455,16 +4793,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3473,17 +4813,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "published_tracks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0", + "next_page_url": null, + "key": "published_tracks" } } } @@ -3498,10 +4852,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipantPublishedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules": { @@ -3510,16 +4861,16 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", "room_sid", "rules" ], - "pathType": "list", "parent": "/Rooms/{RoomSid}/Participants/{Sid}", - "className": "subscribe_rules" + "className": "subscribe_rules", + "pathType": "list" }, "get": { "description": "Returns a list of Subscribe Rules for the Participant.", @@ -3549,6 +4900,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" + }, + "examples": { + "readEmpty": { + "value": { + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": null, + "date_updated": null, + "rules": [ + { + "type": "include", + "all": true, + "publisher": null, + "track": null, + "kind": null, + "priority": null + } + ] + } + } } } }, @@ -3560,10 +4931,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantSubscribeRule", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantSubscribeRule" }, "post": { "description": "Update the Subscribe Rules for the Participant", @@ -3593,6 +4961,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" + }, + "examples": { + "updateFilters": { + "value": { + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": null, + "date_updated": null, + "rules": [ + { + "type": "exclude", + "all": true, + "publisher": null, + "track": null, + "kind": null, + "priority": null + } + ] + } + } } } }, @@ -3605,9 +4993,6 @@ } ], "operationId": "UpdateRoomParticipantSubscribeRule", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3619,6 +5004,13 @@ "description": "A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information." } } + }, + "examples": { + "updateFilters": { + "value": { + "Rules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" + } + } } } } @@ -3631,7 +5023,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3639,8 +5031,8 @@ "enabled", "kind" ], - "pathType": "instance", - "parent": "/Rooms/{RoomSid}/Participants/{Sid}" + "parent": "/Rooms/{RoomSid}/Participants/{Sid}", + "pathType": "instance" }, "get": { "description": "Returns a single Track resource represented by `track_sid`. Note: This is one resource with the Video API that requires a SID, be Track Name on the subscriber side is not guaranteed to be unique.", @@ -3682,6 +5074,22 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track" + }, + "examples": { + "fetch": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisher_sid": "PAbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "bob-track", + "kind": "data", + "enabled": true, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -3693,10 +5101,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantSubscribedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks": { @@ -3705,7 +5110,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3713,8 +5118,8 @@ "enabled", "kind" ], - "pathType": "list", - "parent": "/Rooms/{RoomSid}/Participants/{Sid}" + "parent": "/Rooms/{RoomSid}/Participants/{Sid}", + "pathType": "list" }, "get": { "description": "Returns a list of tracks that are subscribed for the participant.", @@ -3780,16 +5185,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3798,17 +5205,31 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "subscribed_tracks": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0", + "next_page_url": null, + "key": "subscribed_tracks" } } } @@ -3823,10 +5244,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipantSubscribedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Recordings/{Sid}": { @@ -3845,12 +5263,12 @@ "duration", "codec" ], - "pathType": "instance", "dependentProperties": { - "video/v1/room_recording_media": "{room_sid: room_sid, sid: sid}" + "media": "{room_sid: room_sid, sid: sid}" }, "parent": "/Rooms/{Sid}", - "className": "room_recording" + "className": "room_recording", + "pathType": "instance" }, "get": { "description": "", @@ -3886,6 +5304,36 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "processing", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 0, + "type": "audio", + "duration": 0, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "media": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + } } } }, @@ -3897,10 +5345,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomRecording" }, "delete": { "description": "", @@ -3940,10 +5385,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRoomRecording" } }, "/v1/Rooms/{RoomSid}/Recordings": { @@ -3962,12 +5404,12 @@ "duration", "codec" ], - "pathType": "list", "dependentProperties": { - "video/v1/room_recording_media": "{room_sid: room_sid, sid: sid}" + "media": "{room_sid: room_sid, sid: sid}" }, "parent": "/Rooms/{Sid}", - "className": "room_recording" + "className": "room_recording", + "pathType": "list" }, "get": { "description": "", @@ -3991,6 +5433,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_status" + }, + "examples": { + "readResults": { + "value": "completed" + } } }, { @@ -4002,6 +5449,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readResults": { + "value": "source_sid" + } } }, { @@ -4011,6 +5463,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -4020,6 +5477,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -4065,16 +5527,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4083,17 +5547,73 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "recordings": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" + } + } + }, + "readResults": { + "value": { + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T21:00:00Z", + "date_deleted": "2015-07-30T22:00:00Z", + "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "size": 23, + "type": "audio", + "duration": 10, + "container_format": "mka", + "codec": "OPUS", + "track_name": "A name", + "offset": 10, + "grouping_sids": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", + "encryption_key": "public_key", + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "media": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0", + "next_page_url": null, + "key": "recordings" } } } @@ -4108,10 +5628,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomRecording" } }, "/v1/Rooms/{RoomSid}/RecordingRules": { @@ -4120,15 +5637,15 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "rules" ], - "pathType": "list", "parent": "/Rooms/{Sid}", - "className": "recording_rules" + "className": "recording_rules", + "pathType": "list" }, "get": { "description": "Returns a list of Recording Rules for the Room.", @@ -4149,6 +5666,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording_rule" + }, + "examples": { + "fetch": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "rules": [ + { + "type": "include", + "all": true + } + ] + } + } } } }, @@ -4160,10 +5692,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomRecordingRule", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomRecordingRule" }, "post": { "description": "Update the Recording Rules for the Room", @@ -4184,6 +5713,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording_rule" + }, + "examples": { + "update": { + "value": { + "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "rules": [ + { + "type": "include", + "all": true + } + ] + } + } } } }, @@ -4196,9 +5740,6 @@ } ], "operationId": "UpdateRoomRecordingRule", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4210,6 +5751,13 @@ "description": "A JSON-encoded array of recording rules." } } + }, + "examples": { + "update": { + "value": { + "Rules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" + } + } } } } @@ -4221,11 +5769,5 @@ { "url": "https://video.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 61a45e84..f3db24b2 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "voice.v1.archived_call": { "type": "object", @@ -485,6 +491,29 @@ } } }, + "recording_enum_status": { + "type": "string", + "enum": [ + "in-progress", + "paused", + "stopped", + "processing", + "completed", + "absent" + ] + }, + "recording_enum_source": { + "type": "string", + "enum": [ + "DialVerb", + "Conference", + "OutboundAPI", + "Trunking", + "RecordVerb", + "StartCallRecordingAPI", + "StartConferenceRecordingAPI" + ] + }, "voice.v1.source_ip_mapping": { "type": "object", "properties": { @@ -532,12 +561,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -553,7 +576,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -563,11 +586,11 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "archived_calls" + "mountName": "archived_calls", + "pathType": "instance" }, "delete": { "description": "Delete an archived call record from Bulk Export. Note: this does not also delete the record from the Voice API.", @@ -605,10 +628,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteArchivedCall", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteArchivedCall" } }, "/v1/ByocTrunks": { @@ -634,6 +654,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.byoc_trunk" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_url": "https://byoc.example.com/twilio/app", + "voice_method": "POST", + "voice_fallback_method": "POST", + "voice_fallback_url": "https://byoc.example.com/twilio/fallback", + "status_callback_method": "POST", + "status_callback_url": "https://byoc.example.com/twilio/status_callback", + "cnam_lookup_enabled": false, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -646,9 +687,6 @@ } ], "operationId": "CreateByocTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -733,6 +771,22 @@ "description": "The SID of the SIP Domain that should be used in the `From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to \"call back\" an incoming call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to \"sip.twilio.com\"." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "VoiceUrl": "https://byoc.example.com/twilio/app", + "VoiceMethod": "POST", + "VoiceFallbackUrl": "https://byoc.example.com/twilio/fallback", + "VoiceFallbackMethod": "POST", + "StatusCallbackUrl": "https://byoc.example.com/twilio/status_callback", + "StatusCallbackMethod": "POST", + "CnamLookupEnabled": false, + "ConnectionPolicySid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FromDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -784,16 +838,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -802,18 +858,64 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "next_page_url": null, + "key": "byoc_trunks" + }, + "byoc_trunks": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_url": "https://byoc.example.com/twilio/app", + "voice_method": "POST", + "voice_fallback_method": "POST", + "voice_fallback_url": "https://byoc.example.com/twilio/fallback", + "status_callback_method": "POST", + "status_callback_url": "https://byoc.example.com/twilio/status_callback", + "cnam_lookup_enabled": false, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0", + "next_page_url": null, + "key": "byoc_trunks" + }, + "byoc_trunks": [] } } } @@ -827,10 +929,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "ListByocTrunk" } }, "/v1/ByocTrunks/{Sid}": { @@ -870,6 +969,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.byoc_trunk" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "voice_url": "https://byoc.example.com/twilio/app", + "voice_method": "POST", + "voice_fallback_method": "POST", + "voice_fallback_url": "https://byoc.example.com/twilio/fallback", + "status_callback_method": "POST", + "status_callback_url": "https://byoc.example.com/twilio/status_callback", + "cnam_lookup_enabled": false, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -881,10 +1001,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "FetchByocTrunk" }, "post": { "description": "", @@ -908,6 +1025,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.byoc_trunk" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "update_name", + "voice_url": "https://byoc.example.com/twilio_updated/app", + "voice_method": "GET", + "voice_fallback_method": "GET", + "voice_fallback_url": "https://byoc.example.com/twilio_updated/fallback", + "status_callback_method": "GET", + "status_callback_url": "https://byoc.example.com/twilio_updated/status_callback", + "cnam_lookup_enabled": true, + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "from_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -920,9 +1058,6 @@ } ], "operationId": "UpdateByocTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1007,6 +1142,22 @@ "description": "The SID of the SIP Domain that should be used in the `From` header of originating calls sent to your SIP infrastructure. If your SIP infrastructure allows users to \"call back\" an incoming call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to \"sip.twilio.com\"." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "update_name", + "VoiceUrl": "https://byoc.example.com/twilio_updated/app", + "VoiceMethod": "GET", + "VoiceFallbackUrl": "https://byoc.example.com/twilio_updated/fallback", + "VoiceFallbackMethod": "GET", + "StatusCallbackUrl": "https://byoc.example.com/twilio_updated/status_callback", + "StatusCallbackMethod": "GET", + "CnamLookupEnabled": true, + "ConnectionPolicySid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "FromDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + } } } } @@ -1038,10 +1189,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteByocTrunk" } }, "/v1/ConnectionPolicies": { @@ -1056,10 +1204,10 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "connection_policy_target": "{connection_policy_sid: sid}" - } + }, + "pathType": "list" }, "post": { "description": "", @@ -1069,6 +1217,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + } } } }, @@ -1081,9 +1244,6 @@ } ], "operationId": "CreateConnectionPolicy", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1096,6 +1256,13 @@ "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -1147,16 +1314,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1165,18 +1334,58 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "next_page_url": null, + "key": "connection_policies" + }, + "connection_policies": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0", + "next_page_url": null, + "key": "connection_policies" + }, + "connection_policies": [] } } } @@ -1190,10 +1399,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectionPolicy" } }, "/v1/ConnectionPolicies/{Sid}": { @@ -1208,10 +1414,10 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "connection_policy_target": "{connection_policy_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1235,6 +1441,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + } } } }, @@ -1246,10 +1467,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectionPolicy" }, "post": { "description": "", @@ -1273,6 +1491,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "updated_name", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "targets": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets" + } + } + } } } }, @@ -1285,9 +1518,6 @@ } ], "operationId": "UpdateConnectionPolicy", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1300,6 +1530,13 @@ "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name" + } + } } } } @@ -1331,10 +1568,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectionPolicy" } }, "/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets": { @@ -1351,9 +1585,9 @@ "target", "enabled" ], - "pathType": "list", "parent": "/ConnectionPolicies/{Sid}", - "className": "connection_policy_target" + "className": "connection_policy_target", + "pathType": "list" }, "post": { "description": "", @@ -1377,6 +1611,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy.connection_policy_target" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "target": "sip:sip-box.com:1234", + "priority": 1, + "weight": 20, + "enabled": true, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1389,9 +1640,6 @@ } ], "operationId": "CreateConnectionPolicyTarget", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1424,6 +1672,17 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Target": "sip:sip-box.com:1234", + "Priority": 1, + "Weight": 20, + "Enabled": true + } + } } } } @@ -1487,16 +1746,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1505,18 +1766,60 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "next_page_url": null, + "key": "targets" + }, + "targets": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "target": "sip:sip-box.com:1234", + "priority": 1, + "weight": 20, + "enabled": true, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0", + "next_page_url": null, + "key": "targets" + }, + "targets": [] } } } @@ -1530,10 +1833,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectionPolicyTarget" } }, "/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}": { @@ -1550,9 +1850,9 @@ "target", "enabled" ], - "pathType": "instance", "parent": "/ConnectionPolicies/{Sid}", - "className": "connection_policy_target" + "className": "connection_policy_target", + "pathType": "instance" }, "get": { "description": "", @@ -1588,6 +1888,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy.connection_policy_target" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "target": "sip:sip-box.com:1234", + "priority": 1, + "weight": 20, + "enabled": true, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1599,10 +1916,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectionPolicyTarget" }, "post": { "description": "", @@ -1638,6 +1952,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.connection_policy.connection_policy_target" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "updated_name", + "target": "sip:sip-updated.com:4321", + "priority": 2, + "weight": 10, + "enabled": false, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1650,9 +1981,6 @@ } ], "operationId": "UpdateConnectionPolicyTarget", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1682,6 +2010,17 @@ "description": "Whether the Target is enabled." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "Target": "sip:sip-updated.com:4321", + "Priority": 2, + "Weight": 10, + "Enabled": false + } + } } } } @@ -1725,10 +2064,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectionPolicyTarget" } }, "/v1/DialingPermissions": { @@ -1737,11 +2073,11 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "className": "dialing_permissions" + "className": "dialing_permissions", + "pathType": "list" } }, "/v1/DialingPermissions/Countries/{IsoCode}": { @@ -1750,18 +2086,18 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "iso_code", "name", "continent" ], - "pathType": "instance", "dependentProperties": { "highrisk_special_prefix": "{iso_code: iso_code}" }, - "parent": "/DialingPermissions" + "parent": "/DialingPermissions", + "pathType": "instance" }, "get": { "description": "Retrieve voice dialing country permissions identified by the given ISO country code", @@ -1783,6 +2119,25 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country-instance" + }, + "examples": { + "fetch": { + "value": { + "iso_code": "US", + "name": "United States/Canada", + "country_codes": [ + "+1" + ], + "continent": "NORTH_AMERICA", + "low_risk_numbers_enabled": false, + "high_risk_special_numbers_enabled": false, + "high_risk_tollfraud_numbers_enabled": false, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries/US", + "links": { + "highrisk_special_prefixes": "https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes" + } + } + } } } }, @@ -1794,10 +2149,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialingPermissionsCountry", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialingPermissionsCountry" } }, "/v1/DialingPermissions/Countries": { @@ -1806,18 +2158,18 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "iso_code", "name", "continent" ], - "pathType": "list", "dependentProperties": { "highrisk_special_prefix": "{iso_code: iso_code}" }, - "parent": "/DialingPermissions" + "parent": "/DialingPermissions", + "pathType": "list" }, "get": { "description": "Retrieve all voice dialing country permissions for this account", @@ -1829,6 +2181,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readUs": { + "value": "US" + } } }, { @@ -1914,16 +2271,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1932,17 +2291,47 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readUs": { + "value": { + "content": [ + { + "iso_code": "US", + "name": "United States/Canada", + "country_codes": [ + "+1" + ], + "continent": "NORTH_AMERICA", + "low_risk_numbers_enabled": false, + "high_risk_special_numbers_enabled": false, + "high_risk_tollfraud_numbers_enabled": false, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries/US", + "links": { + "highrisk_special_prefixes": "https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes" + } + } + ], + "meta": { + "first_page_url": "https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0", + "key": "content", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0" } } } @@ -1957,10 +2346,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDialingPermissionsCountry", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDialingPermissionsCountry" } }, "/v1/DialingPermissions/BulkCountryUpdates": { @@ -1969,14 +2355,14 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "update_request", "update_count" ], - "pathType": "list", - "parent": "/DialingPermissions" + "parent": "/DialingPermissions", + "pathType": "list" }, "post": { "description": "Create a bulk update request to change voice dialing country permissions of one or more countries identified by the corresponding [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", @@ -1986,6 +2372,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country_bulk_update" + }, + "examples": { + "create": { + "value": { + "update_count": 1, + "update_request": "accepted" + } + } } } }, @@ -1998,9 +2392,6 @@ } ], "operationId": "CreateDialingPermissionsCountryBulkUpdate", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2016,6 +2407,13 @@ "required": [ "UpdateRequest" ] + }, + "examples": { + "create": { + "value": { + "UpdateRequest": "[ { \"iso_code\": \"GB\", \"low_risk_numbers\": \"Enabled\", \"high_risk_special_numbers\":\"Enabled\", \"high_risk_irsf_numbers\": \"Enabled\" } ]" + } + } } } } @@ -2028,14 +2426,14 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "prefix" ], - "pathType": "list", "parent": "/DialingPermissions/Countries/{IsoCode}", - "mountName": "highrisk_special_prefixes" + "mountName": "highrisk_special_prefixes", + "pathType": "list" }, "get": { "description": "Fetch the high-risk special services prefixes from the country resource corresponding to the [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", @@ -2093,16 +2491,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2111,17 +2511,38 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readLv": { + "value": { + "content": [ + { + "prefix": "+37181" + }, + { + "prefix": "+3719000" + } + ], + "meta": { + "first_page_url": "https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0", + "key": "content", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0" } } } @@ -2136,10 +2557,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDialingPermissionsHrsPrefixes", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDialingPermissionsHrsPrefixes" } }, "/v1/Settings": { @@ -2148,14 +2566,14 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "dialing_permissions_inheritance" ], - "pathType": "instance", "parent": "/DialingPermissions", - "className": "settings" + "className": "settings", + "pathType": "instance" }, "get": { "description": "Retrieve voice dialing permissions inheritance for the sub-account", @@ -2165,6 +2583,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings" + }, + "examples": { + "fetch": { + "value": { + "dialing_permissions_inheritance": true, + "url": "https://voice.twilio.com/v1/Settings" + } + } } } }, @@ -2176,10 +2602,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialingPermissionsSettings", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialingPermissionsSettings" }, "post": { "description": "Update voice dialing permissions inheritance for the sub-account", @@ -2189,6 +2612,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings" + }, + "examples": { + "update": { + "value": { + "dialing_permissions_inheritance": true, + "url": "https://voice.twilio.com/v1/Settings" + } + } } } }, @@ -2201,9 +2632,6 @@ } ], "operationId": "UpdateDialingPermissionsSettings", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2216,6 +2644,13 @@ "description": "`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`." } } + }, + "examples": { + "update": { + "value": { + "DialingPermissionsInheritance": true + } + } } } } @@ -2246,6 +2681,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.ip_record" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2258,9 +2707,6 @@ } ], "operationId": "CreateIpRecord", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2284,6 +2730,15 @@ "required": [ "IpAddress" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "10.2.3.4", + "CidrPrefixLength": 30 + } + } } } } @@ -2335,16 +2790,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2353,18 +2810,57 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "next_page_url": null, + "key": "ip_records" + }, + "ip_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0", + "next_page_url": null, + "key": "ip_records" + }, + "ip_records": [] } } } @@ -2378,10 +2874,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListIpRecord" } }, "/v1/IpRecords/{Sid}": { @@ -2422,6 +2915,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.ip_record" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2433,10 +2940,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIpRecord" }, "post": { "description": "", @@ -2460,6 +2964,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.ip_record" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "update_name", + "ip_address": "10.2.3.4", + "cidr_prefix_length": 30, + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2472,9 +2990,6 @@ } ], "operationId": "UpdateIpRecord", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2487,6 +3002,13 @@ "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "update_name" + } + } } } } @@ -2518,10 +3040,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIpRecord" } }, "/v1/SourceIpMappings": { @@ -2547,6 +3066,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.source_ip_mapping" + }, + "examples": { + "create": { + "value": { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:36Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2559,9 +3090,6 @@ } ], "operationId": "CreateSourceIpMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2588,6 +3116,14 @@ "IpRecordSid", "SipDomainSid" ] + }, + "examples": { + "create": { + "value": { + "IpRecordSid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SipDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2639,16 +3175,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2657,18 +3195,55 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "next_page_url": null, + "key": "source_ip_mappings" + }, + "source_ip_mappings": [ + { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "readEmpty": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0", + "next_page_url": null, + "key": "source_ip_mappings" + }, + "source_ip_mappings": [] } } } @@ -2682,10 +3257,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSourceIpMapping" } }, "/v1/SourceIpMappings/{Sid}": { @@ -2725,6 +3297,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.source_ip_mapping" + }, + "examples": { + "fetch": { + "value": { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2736,10 +3320,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSourceIpMapping" }, "post": { "description": "", @@ -2763,6 +3344,18 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.source_ip_mapping" + }, + "examples": { + "update": { + "value": { + "sid": "IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_record_sid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sip_domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "date_created": "2020-03-18T23:31:36Z", + "date_updated": "2020-03-18T23:31:37Z", + "url": "https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2775,9 +3368,6 @@ } ], "operationId": "UpdateSourceIpMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2796,6 +3386,13 @@ "required": [ "SipDomainSid" ] + }, + "examples": { + "update": { + "value": { + "SipDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + } } } } @@ -2827,10 +3424,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSourceIpMapping" } } }, @@ -2838,19 +3432,5 @@ { "url": "https://voice.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - }, - { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com." - } ] } \ No newline at end of file diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index aa4901ab..ea8e4464 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "wireless.v1.account_usage_record": { "type": "object", @@ -587,12 +593,6 @@ "all" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -608,7 +608,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.43.2" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -635,6 +635,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -644,6 +649,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -698,16 +708,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -716,17 +728,92 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "fetch": { + "value": { + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2, + "home": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2 + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "from_sim": 0, + "to_sim": 0 + }, + "international_roaming": [] + }, + "data": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes", + "home": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes" + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "upload": 0, + "download": 0, + "units": "bytes" + }, + "international_roaming": [] + }, + "period": { + "start": "2015-07-30T20:00:00Z", + "end": "2015-07-30T20:00:00Z" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": {}, + "data": {}, + "period": {} + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0" } } } @@ -741,10 +828,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListAccountUsageRecord" } }, "/v1/Commands/{Sid}": { @@ -787,6 +871,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.command" + }, + "examples": { + "fetchCommandSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "from_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "sms", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetchCommandIp": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": false, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "to_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "ip", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -798,10 +916,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCommand", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCommand" }, "delete": { "description": "Delete a Command instance from your account.", @@ -829,10 +944,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCommand", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCommand" } }, "/v1/Commands": { @@ -862,6 +974,17 @@ "description": "The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "sim" + }, + "readFull": { + "value": "sim" + }, + "readIp": { + "value": "sim" + } } }, { @@ -871,6 +994,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "queued" + }, + "readFull": { + "value": "queued" + }, + "readIp": { + "value": "queued" + } } }, { @@ -880,6 +1014,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_direction" + }, + "examples": { + "readEmpty": { + "value": "from_sim" + }, + "readFull": { + "value": "from_sim" + }, + "readIp": { + "value": "to_sim" + } } }, { @@ -889,6 +1034,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_transport" + }, + "examples": { + "readIp": { + "value": "ip" + } } }, { @@ -934,16 +1084,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -952,17 +1104,89 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "commands": [], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "from_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "sms", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0" + } + } + }, + "readIp": { + "value": { + "commands": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "binary", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "to_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "ip", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0", + "key": "commands", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0" } } } @@ -977,10 +1201,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCommand", - "x-maturity": [ - "GA" - ] + "operationId": "ListCommand" }, "post": { "description": "Send a Command to a Sim.", @@ -990,6 +1211,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.command" + }, + "examples": { + "createCommandSms": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "text", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "from_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "sms", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCommandIp": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "binary", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "delivery_receipt_requested": true, + "direction": "to_sim", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "transport": "ip", + "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1002,9 +1257,6 @@ } ], "operationId": "CreateCommand", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1055,6 +1307,29 @@ "required": [ "Command" ] + }, + "examples": { + "createCommandSms": { + "value": { + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "text", + "Sim": "sim", + "IncludeSid": "include_sid" + } + }, + "createCommandIp": { + "value": { + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "Command": "command", + "CommandMode": "binary", + "DeliveryReceiptRequested": true, + "Sim": "sim", + "IncludeSid": "include_sid" + } + } } } } @@ -1076,8 +1351,8 @@ "start", "end" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1134,16 +1409,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1152,17 +1429,68 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "fetch": { + "value": { + "data_sessions": [ + { + "sid": "WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "radio_link": "LTE", + "operator_mcc": "", + "operator_mnc": "", + "operator_country": "", + "operator_name": "", + "cell_id": "", + "cell_location_estimate": {}, + "packets_uploaded": 0, + "packets_downloaded": 0, + "last_updated": "2015-07-30T20:00:00Z", + "start": "2015-07-30T20:00:00Z", + "end": null, + "imei": null + }, + { + "sid": "WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "radio_link": "3G", + "operator_mcc": "", + "operator_mnc": "", + "operator_country": "", + "operator_name": "", + "cell_id": "", + "cell_location_estimate": {}, + "packets_uploaded": 0, + "packets_downloaded": 0, + "last_updated": "2015-07-30T20:00:00Z", + "start": "2015-07-30T20:00:00Z", + "end": "2015-07-30T20:00:00Z", + "imei": "014931000129700" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0", + "key": "data_sessions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0" } } } @@ -1177,10 +1505,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDataSession", - "x-maturity": [ - "GA" - ] + "operationId": "ListDataSession" } }, "/v1/RatePlans": { @@ -1245,16 +1570,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1263,18 +1590,72 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0", + "key": "rate_plans", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0" + }, + "rate_plans": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "data_limit_strategy": "block", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } @@ -1288,10 +1669,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "ListRatePlan" }, "post": { "description": "", @@ -1301,6 +1679,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.rate_plan" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_limit_strategy": "block", + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1313,9 +1720,6 @@ } ], "operationId": "CreateRatePlan", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1371,6 +1775,28 @@ "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB." } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name", + "DataEnabled": true, + "DataLimit": 1000, + "DataMetering": "payg", + "MessagingEnabled": true, + "VoiceEnabled": true, + "FriendlyName": "friendly_name", + "NationalRoamingEnabled": true, + "InternationalRoaming": [ + "data", + "voice", + "messaging" + ], + "NationalRoamingDataLimit": 1000, + "InternationalRoamingDataLimit": 1000, + "Status": "status" + } + } } } } @@ -1412,6 +1838,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.rate_plan" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "data_limit_strategy": "block", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1423,10 +1878,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRatePlan" }, "post": { "description": "", @@ -1447,6 +1899,35 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.rate_plan" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "data_enabled": true, + "data_limit": 1000, + "data_metering": "payg", + "date_created": "2019-07-30T20:00:00Z", + "date_updated": "2019-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "messaging_enabled": true, + "voice_enabled": true, + "national_roaming_enabled": true, + "national_roaming_data_limit": 1000, + "international_roaming": [ + "data", + "messaging", + "voice" + ], + "international_roaming_data_limit": 1000, + "sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_notification_method": "POST", + "usage_notification_url": "https://callback.com", + "data_limit_strategy": "block", + "url": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1459,9 +1940,6 @@ } ], "operationId": "UpdateRatePlan", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1478,6 +1956,16 @@ "description": "A descriptive string that you create to describe the resource. It does not have to be unique." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name", + "UsageNotificationMethod": "POST", + "UsageNotificationUrl": "https://callback.com" + } + } } } } @@ -1506,10 +1994,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRatePlan" } }, "/v1/Sims/{Sid}": { @@ -1526,11 +2011,11 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { "usage_record": "{sim_sid: sid}", "data_session": "{sim_sid: sid}" - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Sim resource on your Account.", @@ -1551,6 +2036,40 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.sim" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": null, + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.1" + } + } } } }, @@ -1562,10 +2081,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSim", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSim" }, "post": { "description": "Updates the given properties of a Sim resource on your Account.", @@ -1586,6 +2102,104 @@ "application/json": { "schema": { "$ref": "#/components/schemas/wireless.v1.sim" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": null, + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + }, + "updateMoveToSubaccount": { + "value": { + "account_sid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": null, + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + }, + "updateResetConnectivity": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "GET", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "active", + "reset_status": "resetting", + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + } } } }, @@ -1598,9 +2212,6 @@ } ], "operationId": "UpdateSim", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1743,6 +2354,41 @@ "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts)." } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "CallbackMethod": "callback_method", + "CallbackUrl": "http://www.example.com", + "CommandsCallbackMethod": "POST", + "CommandsCallbackUrl": "http://www.example.com", + "VoiceMethod": "POST", + "VoiceUrl": "http://www.example.com", + "VoiceFallbackMethod": "POST", + "VoiceFallbackUrl": "http://www.example.com", + "SmsMethod": "POST", + "SmsUrl": "http://www.example.com", + "SmsFallbackMethod": "POST", + "SmsFallbackUrl": "http://www.example.com", + "FriendlyName": "friendly_name", + "RatePlan": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Status": "new" + } + }, + "updateMoveToSubaccount": { + "value": { + "AccountSid": "ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "UniqueName": "unique_name", + "RatePlan": "WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "Status": "new" + } + }, + "updateResetConnectivity": { + "value": { + "ResetStatus": "resetting" + } + } } } } @@ -1771,10 +2417,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSim", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSim" } }, "/v1/Sims": { @@ -1791,11 +2434,11 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { "usage_record": "{sim_sid: sid}", "data_session": "{sim_sid: sid}" - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of Sim resources on your Account.", @@ -1807,6 +2450,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sim_enum_status" + }, + "examples": { + "readEmpty": { + "value": "new" + }, + "readFull": { + "value": "new" + } } }, { @@ -1815,6 +2466,14 @@ "description": "Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } } }, { @@ -1823,6 +2482,14 @@ "description": "The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "rate_plan" + }, + "readFull": { + "value": "rate_plan" + } } }, { @@ -1884,16 +2551,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1902,17 +2571,76 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "sims": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "POST", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "data_sessions": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions", + "rate_plan": "https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usage_records": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "new", + "reset_status": "resetting", + "sms_fallback_method": "POST", + "sms_fallback_url": "http://www.example.com", + "sms_method": "POST", + "sms_url": "http://www.example.com", + "voice_fallback_method": "POST", + "voice_fallback_url": "http://www.example.com", + "voice_method": "POST", + "voice_url": "http://www.example.com", + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ip_address": "192.168.1.30" + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" } } } @@ -1927,10 +2655,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSim", - "x-maturity": [ - "GA" - ] + "operationId": "ListSim" } }, "/v1/Sims/{SimSid}/UsageRecords": { @@ -1944,8 +2669,8 @@ "defaultOutputProperties": [ "period" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1966,6 +2691,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -1975,6 +2705,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -2029,16 +2764,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2047,17 +2784,94 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } + }, + "type": "object" + } + } + }, + "examples": { + "fetch": { + "value": { + "usage_records": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2, + "home": { + "billing_units": "USD", + "billed": 0, + "total": 3, + "from_sim": 1, + "to_sim": 2 + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "from_sim": 0, + "to_sim": 0 + }, + "international_roaming": [] + }, + "data": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes", + "home": { + "billing_units": "USD", + "billed": 0.35, + "total": 3494609, + "upload": 731560, + "download": 2763049, + "units": "bytes" + }, + "national_roaming": { + "billing_units": "USD", + "billed": 0, + "total": 0, + "upload": 0, + "download": 0, + "units": "bytes" + }, + "international_roaming": [] + }, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": { + "start": "2015-07-30T20:00:00Z", + "end": "2015-07-30T20:00:00Z" + } + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands": {}, + "data": {}, + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": {} + } + ], + "meta": { + "first_page_url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0", + "key": "usage_records", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0" } } } @@ -2072,10 +2886,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecord" } } }, @@ -2083,11 +2894,5 @@ { "url": "https://wireless.twilio.com" } - ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - } ] } \ No newline at end of file diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 32c67399..128f94a7 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: accounts.v1.auth_token_promotion: type: object @@ -148,10 +152,6 @@ components: format: uri nullable: true description: The URI for this resource, relative to `https://accounts.twilio.com` - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Accounts description: This is the public Twilio REST API. @@ -163,7 +163,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: @@ -175,8 +175,8 @@ paths: - account_sid - auth_token - date_created - pathType: instance mountName: auth_token_promotion + pathType: instance post: description: Promote the secondary Auth Token to primary. After promoting the new token, all requests to Twilio using your old primary Auth Token will result @@ -187,16 +187,22 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.auth_token_promotion' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auth_token: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + url: https://accounts.twilio.com/v1/AuthTokens/Promote description: OK security: - accountSid_authToken: [] operationId: UpdateAuthTokenPromotion - x-maturity: - - GA /v1/Credentials: servers: - url: https://accounts.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list @@ -209,8 +215,8 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Credentials + pathType: list get: description: Retrieves a collection of AWS Credentials belonging to the account used to make the request @@ -247,34 +253,61 @@ paths: items: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + credentials: [] + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 + readFull: + value: + credentials: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/AWS?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCredentialAws - x-maturity: - - GA post: description: Create a new AWS Credential responses: @@ -283,12 +316,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredentialAws - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -315,6 +355,12 @@ paths: issuing the request. required: - Credentials + examples: + create: + value: + AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Credentials: aws_credentials /v1/Credentials/AWS/{Sid}: servers: - url: https://accounts.twilio.com @@ -324,8 +370,8 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Credentials + pathType: instance get: description: Fetch the AWS credentials specified by the provided Credential Sid @@ -346,12 +392,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredentialAws - x-maturity: - - GA post: description: Modify the properties of a given Account parameters: @@ -371,12 +424,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_aws' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/AWS/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredentialAws - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -388,6 +448,11 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: friendly_name + Credentials: aws_credentials delete: description: Delete a Credential from your account parameters: @@ -407,8 +472,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredentialAws - x-maturity: - - GA /v1/Credentials/PublicKeys: servers: - url: https://accounts.twilio.com @@ -418,9 +481,9 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Credentials mountName: public_key + pathType: list get: description: Retrieves a collection of Public Key Credentials belonging to the account used to make the request @@ -457,34 +520,61 @@ paths: items: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + credentials: [] + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 + readFull: + value: + credentials: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 + key: credentials + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://accounts.twilio.com/v1/Credentials/PublicKeys?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCredentialPublicKey - x-maturity: - - GA post: description: Create a new Public Key Credential responses: @@ -493,12 +583,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredentialPublicKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -525,6 +622,12 @@ paths: issuing the request required: - PublicKey + examples: + create: + value: + AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PublicKey: public_key /v1/Credentials/PublicKeys/{Sid}: servers: - url: https://accounts.twilio.com @@ -534,9 +637,9 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Credentials mountName: public_key + pathType: instance get: description: Fetch the public key specified by the provided Credential Sid parameters: @@ -556,12 +659,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredentialPublicKey - x-maturity: - - GA post: description: Modify the properties of a given Account parameters: @@ -581,12 +691,19 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.credential.credential_public_key' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + friendly_name: friendly_name + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://accounts.twilio.com/v1/Credentials/PublicKeys/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredentialPublicKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -598,6 +715,11 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: friendly_name + PublicKey: public_key delete: description: Delete a Credential from your account parameters: @@ -617,8 +739,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredentialPublicKey - x-maturity: - - GA /v1/AuthTokens/Secondary: servers: - url: https://accounts.twilio.com @@ -628,8 +748,8 @@ paths: - account_sid - secondary_auth_token - date_created - pathType: instance mountName: secondary_auth_token + pathType: instance post: description: Create a new secondary Auth Token responses: @@ -638,12 +758,18 @@ paths: application/json: schema: $ref: '#/components/schemas/accounts.v1.secondary_auth_token' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-31T04:00:00Z' + date_updated: '2015-07-31T04:00:00Z' + secondary_auth_token: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + url: https://accounts.twilio.com/v1/AuthTokens/Secondary description: Created security: - accountSid_authToken: [] operationId: CreateSecondaryAuthToken - x-maturity: - - GA delete: description: Delete the secondary Auth Token from your account responses: @@ -652,10 +778,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSecondaryAuthToken - x-maturity: - - GA servers: - url: https://accounts.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 8197bf9d..c5394fda 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: api.v2010.account: type: object @@ -3867,6 +3871,51 @@ components: enum: - confirmed - unconfirmed + message_real_resource_enum_status: + type: string + enum: + - queued + - sending + - sent + - failed + - delivered + - undelivered + - receiving + - received + - accepted + - scheduled + - read + - partially_delivered + - canceled + message_real_resource_enum_update_status: + type: string + enum: + - canceled + message_real_resource_enum_direction: + type: string + enum: + - inbound + - outbound-api + - outbound-call + - outbound-reply + message_real_resource_enum_content_retention: + type: string + enum: + - retain + - discard + message_real_resource_enum_address_retention: + type: string + enum: + - retain + - obfuscate + message_real_resource_enum_traffic_type: + type: string + enum: + - free + message_real_resource_enum_schedule_type: + type: string + enum: + - fixed api.v2010.account.new_key: type: object properties: @@ -5530,6 +5579,21 @@ components: type: string enum: - stopped + sms_message_enum_status: + type: string + enum: + - queued + - sending + - sent + - failed + - received + sms_message_enum_direction: + type: string + enum: + - inbound + - outbound-api + - outbound-call + - outbound-reply api.v2010.account.call.stream: type: object properties: @@ -9162,10 +9226,6 @@ components: nullable: true description: The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Api description: This is the public Twilio REST API. @@ -9177,7 +9237,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: @@ -9189,7 +9249,6 @@ paths: - sid - friendly_name - status - pathType: list dependentProperties: address: '{account_sid: sid}' application: '{account_sid: sid}' @@ -9202,7 +9261,6 @@ paths: incoming_phone_number: '{account_sid: sid}' key: '{account_sid: sid}' message: '{account_sid: sid}' - api/v2010/message_real_resource: '{account_sid: sid}' new_key: '{account_sid: sid}' new_signing_key: '{account_sid: sid}' notification: '{account_sid: sid}' @@ -9211,12 +9269,13 @@ paths: recording: '{account_sid: sid}' signing_key: '{account_sid: sid}' sip: '{account_sid: sid}' - api/v2010/sms: '{account_sid: sid}' + sms: '{account_sid: sid}' short_code: '{account_sid: sid}' token: '{account_sid: sid}' transcription: '{account_sid: sid}' usage: '{account_sid: sid}' validation_request: '{account_sid: sid}' + pathType: list post: description: Create a new Twilio Subaccount from the account making the request responses: @@ -9225,12 +9284,43 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account' + examples: + create: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateAccount - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9242,6 +9332,10 @@ paths: type: string description: A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}` + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieves a collection of Accounts belonging to the account used to make the request @@ -9252,6 +9346,11 @@ paths: match this name. schema: type: string + examples: + readEmpty: + value: friendly_name + readFull: + value: friendly_name - name: Status in: query description: Only return Account resources with the given status. Can be `closed`, @@ -9259,6 +9358,11 @@ paths: schema: type: string $ref: '#/components/schemas/account_enum_status' + examples: + readEmpty: + value: active + readFull: + value: active - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9283,41 +9387,95 @@ paths: content: application/json: schema: - type: object - title: ListAccountResponse - properties: - accounts: - type: array - items: - $ref: '#/components/schemas/api.v2010.account' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAccountResponse + properties: + accounts: + type: array + items: + $ref: '#/components/schemas/api.v2010.account' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + end: 0 + previous_page_uri: null + accounts: [] + uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + end: 0 + previous_page_uri: null + accounts: + - auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + uri: /2010-04-01/Accounts.json?FriendlyName=friendly_name&Status=active&PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListAccount - x-maturity: - - GA /2010-04-01/Accounts/{Sid}.json: servers: - url: https://api.twilio.com @@ -9327,7 +9485,6 @@ paths: - sid - friendly_name - status - pathType: instance dependentProperties: address: '{account_sid: sid}' application: '{account_sid: sid}' @@ -9340,7 +9497,6 @@ paths: incoming_phone_number: '{account_sid: sid}' key: '{account_sid: sid}' message: '{account_sid: sid}' - api/v2010/message_real_resource: '{account_sid: sid}' new_key: '{account_sid: sid}' new_signing_key: '{account_sid: sid}' notification: '{account_sid: sid}' @@ -9349,12 +9505,13 @@ paths: recording: '{account_sid: sid}' signing_key: '{account_sid: sid}' sip: '{account_sid: sid}' - api/v2010/sms: '{account_sid: sid}' + sms: '{account_sid: sid}' short_code: '{account_sid: sid}' token: '{account_sid: sid}' transcription: '{account_sid: sid}' usage: '{account_sid: sid}' validation_request: '{account_sid: sid}' + pathType: instance get: description: Fetch the account specified by the provided Account Sid parameters: @@ -9373,12 +9530,43 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account' + examples: + fetch: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchAccount - x-maturity: - - GA post: description: Modify the properties of a given Account parameters: @@ -9397,12 +9585,75 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account' + examples: + update: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + updateWithNumericStatus: + value: + auth_token: auth_token + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + owner_account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + subresource_uris: + available_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + calls: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json + conferences: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json + incoming_phone_numbers: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + outgoing_caller_ids: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json + signing_keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json + connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + sip: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP.json + authorized_connect_apps: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + usage: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage.json + keys: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json + applications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json + short_codes: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + queues: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json + messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json + balance: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Balance.json + type: Full + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateAccount - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9419,6 +9670,14 @@ paths: description: 'Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.' + examples: + update: + value: + FriendlyName: friendly_name + Status: active + updateWithNumericStatus: + value: + Status: '1' /2010-04-01/Accounts/{AccountSid}/Addresses.json: servers: - url: https://api.twilio.com @@ -9432,10 +9691,10 @@ paths: - friendly_name - validated - verified - pathType: list dependentProperties: dependent_phone_number: '{account_sid: account_sid, address_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list post: description: '' parameters: @@ -9455,12 +9714,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9511,6 +9787,16 @@ paths: - Region - PostalCode - IsoCountry + examples: + create: + value: + City: city + CustomerName: customer_name + FriendlyName: friendly_name + IsoCountry: US + PostalCode: postal_code + Region: region + Street: street get: description: '' parameters: @@ -9529,17 +9815,32 @@ paths: description: The `customer_name` of the Address resources to read. schema: type: string + examples: + readFull: + value: customer_name + readEmpty: + value: customer_name - name: FriendlyName in: query description: The string that identifies the Address resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: IsoCountry in: query description: The ISO country code of the Address resources to read. schema: type: string format: iso-country-code + examples: + readFull: + value: US + readEmpty: + value: US - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9564,41 +9865,87 @@ paths: content: application/json: schema: - type: object - title: ListAddressResponse - properties: - addresses: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.address' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAddressResponse + properties: + addresses: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.address' + examples: + readFull: + value: + addresses: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + readEmpty: + value: + addresses: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAddress - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json: servers: - url: https://api.twilio.com @@ -9612,10 +9959,10 @@ paths: - friendly_name - validated - verified - pathType: instance dependentProperties: dependent_phone_number: '{account_sid: account_sid, address_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance delete: description: '' parameters: @@ -9645,8 +9992,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAddress - x-maturity: - - GA get: description: '' parameters: @@ -9676,12 +10021,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchAddress - x-maturity: - - GA post: description: '' parameters: @@ -9711,12 +10073,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + city: SF + customer_name: name + date_created: Tue, 18 Aug 2015 17:07:30 +0000 + date_updated: Tue, 18 Aug 2015 17:07:30 +0000 + emergency_enabled: false + friendly_name: null + iso_country: US + postal_code: '94019' + region: CA + sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + street: 4th + street_secondary: null + validated: false + verified: false + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9756,6 +10135,15 @@ paths: StreetSecondary: type: string description: The additional number and street address of the address. + examples: + update: + value: + City: city + CustomerName: customer_name + FriendlyName: friendly_name + PostalCode: postal_code + Region: region + Street: street /2010-04-01/Accounts/{AccountSid}/Applications.json: servers: - url: https://api.twilio.com @@ -9768,8 +10156,8 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new application within your account parameters: @@ -9789,12 +10177,34 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:59:45 +0000 + date_updated: Tue, 18 Aug 2015 16:48:57 +0000 + friendly_name: Application Friendly Name + message_status_callback: http://www.example.com/sms-status-callback + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: http://www.example.com/sms-fallback + sms_method: GET + sms_status_callback: http://www.example.com/sms-status-callback + sms_url: http://example.com + status_callback: http://example.com + status_callback_method: GET + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: http://www.example.com/voice-callback + voice_method: GET + voice_url: http://example.com + public_application_connect_enabled: true description: Created security: - accountSid_authToken: [] operationId: CreateApplication - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -9915,6 +10325,24 @@ paths: type: boolean description: 'Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.' + examples: + create: + value: + FriendlyName: friendly_name + MessageStatusCallback: https://example.com + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsStatusCallback: https://example.com + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceCallerIdLookup: true + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + PublicApplicationConnectEnabled: true get: description: Retrieve a list of applications representing an application within the requesting account @@ -9934,6 +10362,11 @@ paths: description: The string that identifies the Application resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9958,41 +10391,86 @@ paths: content: application/json: schema: - type: object - title: ListApplicationResponse - properties: - applications: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.application' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListApplicationResponse + properties: + applications: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.application' + examples: + readFull: + value: + applications: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 21 Aug 2015 00:07:25 +0000 + date_updated: Fri, 21 Aug 2015 00:07:25 +0000 + friendly_name: d8821fb7-4d01-48b2-bdc5-34e46252b90b + message_status_callback: null + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_status_callback: null + sms_url: null + status_callback: null + status_callback_method: POST + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + public_application_connect_enabled: false + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + next_page_uri: null + previous_page_uri: null + page_size: 1 + page: 0 + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + readEmpty: + value: + applications: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 + previous_page_uri: null + page_size: 1 + start: 0 + next_page_uri: null + page: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListApplication - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json: servers: - url: https://api.twilio.com @@ -10005,8 +10483,8 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance delete: description: Delete the application by the specified application sid parameters: @@ -10036,8 +10514,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteApplication - x-maturity: - - GA get: description: Fetch the application specified by the provided sid parameters: @@ -10067,12 +10543,34 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:59:45 +0000 + date_updated: Tue, 18 Aug 2015 16:48:57 +0000 + friendly_name: Application Friendly Name + message_status_callback: http://www.example.com/sms-status-callback + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: http://www.example.com/sms-fallback + sms_method: GET + sms_status_callback: http://www.example.com/sms-status-callback + sms_url: http://example.com + status_callback: http://example.com + status_callback_method: GET + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: http://www.example.com/voice-callback + voice_method: GET + voice_url: http://example.com + public_application_connect_enabled: false description: OK security: - accountSid_authToken: [] operationId: FetchApplication - x-maturity: - - GA post: description: Updates the application's properties parameters: @@ -10102,12 +10600,34 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:59:45 +0000 + date_updated: Tue, 18 Aug 2015 16:48:57 +0000 + friendly_name: Application Friendly Name + message_status_callback: http://www.example.com/sms-status-callback + sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: http://www.example.com/sms-fallback + sms_method: GET + sms_status_callback: http://www.example.com/sms-status-callback + sms_url: http://example.com + status_callback: http://example.com + status_callback_method: GET + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Applications/APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: http://www.example.com/voice-callback + voice_method: GET + voice_url: http://example.com + public_application_connect_enabled: true description: OK security: - accountSid_authToken: [] operationId: UpdateApplication - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -10230,6 +10750,24 @@ paths: type: boolean description: 'Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.' + examples: + update: + value: + FriendlyName: friendly_name + MessageStatusCallback: https://example.com + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsStatusCallback: https://example.com + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceCallerIdLookup: true + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + PublicApplicationConnectEnabled: true /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json: servers: - url: https://api.twilio.com @@ -10238,8 +10776,8 @@ paths: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of an authorized-connect-app parameters: @@ -10268,12 +10806,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connect_app_company_name: aaa + connect_app_description: alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj + connect_app_friendly_name: aaa + connect_app_homepage_url: http://www.google.com + connect_app_sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + permissions: + - get-all + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchAuthorizedConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json: servers: - url: https://api.twilio.com @@ -10282,8 +10832,8 @@ paths: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of authorized-connect-apps belonging to the account used to make the request @@ -10322,41 +10872,82 @@ paths: content: application/json: schema: - type: object - title: ListAuthorizedConnectAppResponse - properties: - authorized_connect_apps: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAuthorizedConnectAppResponse + properties: + authorized_connect_apps: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' + examples: + readFull: + value: + authorized_connect_apps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connect_app_company_name: YOUR OTHER MOM + connect_app_description: alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj + connect_app_friendly_name: YOUR MOM + connect_app_homepage_url: http://www.google.com + connect_app_sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + permissions: + - get-all + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json + readEmpty: + value: + authorized_connect_apps: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json description: OK security: - accountSid_authToken: [] operationId: ListAuthorizedConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json: servers: - url: https://api.twilio.com @@ -10366,7 +10957,6 @@ paths: - country_code - country - beta - pathType: list dependentProperties: local: '{account_sid: account_sid, country_code: country_code}' toll_free: '{account_sid: account_sid, country_code: country_code}' @@ -10377,6 +10967,7 @@ paths: machine_to_machine: '{account_sid: account_sid, country_code: country_code}' parent: /Accounts/{Sid}.json className: available_phone_number_country + pathType: list get: description: '' parameters: @@ -10414,41 +11005,58 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberCountryResponse - properties: - countries: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberCountryResponse + properties: + countries: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' + examples: + readFull: + value: + countries: + - beta: false + country: Denmark + country_code: DK + subresource_uris: + local: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK/Local.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/DK.json + end: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json + readEmpty: + value: + countries: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberCountry - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json: servers: - url: https://api.twilio.com @@ -10458,7 +11066,6 @@ paths: - country_code - country - beta - pathType: instance dependentProperties: local: '{account_sid: account_sid, country_code: country_code}' toll_free: '{account_sid: account_sid, country_code: country_code}' @@ -10469,6 +11076,7 @@ paths: machine_to_machine: '{account_sid: account_sid, country_code: country_code}' parent: /Accounts/{Sid}.json className: available_phone_number_country + pathType: instance get: description: '' parameters: @@ -10497,12 +11105,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' + examples: + fetch: + value: + beta: null + country: United States + country_code: US + subresource_uris: + local: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json + toll_free: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US.json description: OK security: - accountSid_authToken: [] operationId: FetchAvailablePhoneNumberCountry - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json: servers: - url: https://api.twilio.com @@ -10512,8 +11128,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -10592,6 +11208,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -10678,41 +11299,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberLocalResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberLocalResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: true + sms: false + voice: true + friendly_name: (808) 925-1571 + iso_country: US + lata: '834' + latitude: '19.720000' + locality: Hilo + longitude: '-155.090000' + phone_number: '+18089251571' + postal_code: '96720' + rate_center: HILO + region: HI + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberLocal - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json: servers: - url: https://api.twilio.com @@ -10722,8 +11369,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -10802,6 +11449,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -10888,41 +11540,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberMachineToMachineResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberMachineToMachineResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberMachineToMachine - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json: servers: - url: https://api.twilio.com @@ -10932,8 +11610,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -11012,6 +11690,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11098,41 +11781,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberMobileResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberMobileResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberMobile - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json: servers: - url: https://api.twilio.com @@ -11142,8 +11851,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -11222,6 +11931,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11308,41 +12022,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberNationalResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberNationalResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberNational - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json: servers: - url: https://api.twilio.com @@ -11352,8 +12092,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -11432,6 +12172,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11518,41 +12263,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberSharedCostResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberSharedCostResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberSharedCost - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json: servers: - url: https://api.twilio.com @@ -11562,8 +12333,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -11642,6 +12413,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11728,41 +12504,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberTollFreeResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberTollFreeResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: true + sms: true + voice: true + friendly_name: (800) 100-0052 + iso_country: US + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+18001000052' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberTollFree - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json: servers: - url: https://api.twilio.com @@ -11772,8 +12574,8 @@ paths: - phone_number - region - beta - pathType: list parent: /Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json + pathType: list get: description: '' parameters: @@ -11852,6 +12654,11 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: NearNumber in: query description: Given a phone number, find a geographically close number within @@ -11938,41 +12745,67 @@ paths: content: application/json: schema: - type: object - title: ListAvailablePhoneNumberVoipResponse - properties: - available_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListAvailablePhoneNumberVoipResponse + properties: + available_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' + examples: + readFull: + value: + available_phone_numbers: + - address_requirements: none + beta: false + capabilities: + mms: false + sms: true + voice: false + friendly_name: '+4759440374' + iso_country: 'NO' + lata: null + latitude: null + locality: null + longitude: null + phone_number: '+4759440374' + postal_code: null + rate_center: null + region: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json + readEmpty: + value: + available_phone_numbers: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json description: OK security: - accountSid_authToken: [] operationId: ListAvailablePhoneNumberVoip - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Balance.json: servers: - url: https://api.twilio.com @@ -11982,8 +12815,8 @@ paths: - account_sid - balance - currency - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Fetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance @@ -12004,12 +12837,16 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.balance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + balance: '0.05' + currency: USD description: OK security: - accountSid_authToken: [] operationId: FetchBalance - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls.json: servers: - url: https://api.twilio.com @@ -12022,7 +12859,6 @@ paths: - to - status - start_time - pathType: list dependentProperties: recording: '{account_sid: account_sid, call_sid: sid}' notification: '{account_sid: account_sid, call_sid: sid}' @@ -12034,6 +12870,7 @@ paths: user_defined_message_subscription: '{account_sid: account_sid, call_sid: sid}' user_defined_message: '{account_sid: account_sid, call_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections @@ -12054,12 +12891,89 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+14158675309' + to_formatted: (415) 867-5309 + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' + createWithTwiml: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+14158675309' + to_formatted: (415) 867-5309 + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' description: Created security: - accountSid_authToken: [] operationId: CreateCall - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -12333,6 +13247,73 @@ paths: required: - To - From + examples: + create: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FallbackMethod: GET + FallbackUrl: https://example.com + From: '+987654321' + IfMachine: if_machine + MachineDetection: enable + MachineDetectionTimeout: 15 + Method: GET + Record: 'true' + RecordingTrack: both + Trim: do-not-trim + SendDigits: send_digits + StatusCallback: https://example.com + StatusCallbackMethod: GET + Timeout: 1 + To: '+123456789' + Url: https://example.com + CallerId: Caller + MachineDetectionSpeechThreshold: 3000 + MachineDetectionSpeechEndThreshold: 3000 + MachineDetectionSilenceTimeout: 3000 + AsyncAmd: 'true' + AsyncAmdStatusCallback: http://statuscallback.com + AsyncAmdStatusCallbackMethod: POST + MachineDetectionEngine: Lumenvox + MachineDetectionMinWordLength: 100 + MachineDetectionMaxWordLength: 5000 + MachineDetectionWordsSilence: 50 + MachineDetectionMaxNumOfWords: 5 + MachineDetectionSilenceThreshold: 256 + Byoc: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CallReason: Reason for the call (Beta) + TimeLimit: 3600 + CallToken: call-token-string + Transcribe: 'true' + TranscriptionConfiguration: JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithTwiml: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FallbackMethod: GET + FallbackUrl: https://example.com + From: '+987654321' + IfMachine: if_machine + MachineDetection: enable + MachineDetectionTimeout: 15 + Method: '' + Record: 'true' + Trim: do-not-trim + SendDigits: send_digits + StatusCallback: https://example.com + StatusCallbackMethod: GET + Timeout: 1 + To: '+123456789' + Url: '' + CallerId: Caller + MachineDetectionSpeechThreshold: 3000 + MachineDetectionSpeechEndThreshold: 3000 + MachineDetectionSilenceTimeout: 3000 + Twiml: Enjoy + CallReason: Reason for the call (Beta) + TimeLimit: 3600 + CallToken: call-token-string + Transcribe: 'true' + TranscriptionConfiguration: JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa x-twilio: conditional: - - url @@ -12358,6 +13339,17 @@ paths: schema: type: string format: phone-number + examples: + readFullPage1: + value: '+123456789' + readFullPage2: + value: '+123456789' + readEmptyDatesGreater: + value: '+123456789' + readEmptyDatesLess: + value: '+123456789' + readEmptyDateFunDateFormats: + value: '+123456789' - name: From in: query description: Only include calls from this phone number, SIP address, Client @@ -12365,6 +13357,17 @@ paths: schema: type: string format: phone-number + examples: + readFullPage1: + value: '+987654321' + readFullPage2: + value: '+987654321' + readEmptyDatesGreater: + value: '+987654321' + readEmptyDatesLess: + value: '+987654321' + readEmptyDateFunDateFormats: + value: '+987654321' - name: ParentCallSid in: query description: Only include calls spawned by calls with this SID. @@ -12373,6 +13376,17 @@ paths: minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ + examples: + readFullPage1: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFullPage2: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmptyDatesGreater: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmptyDatesLess: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmptyDateFunDateFormats: + value: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: 'The status of the calls to include. Can be: `queued`, `ringing`, @@ -12380,6 +13394,17 @@ paths: schema: type: string $ref: '#/components/schemas/call_enum_status' + examples: + readFullPage1: + value: completed + readFullPage2: + value: completed + readEmptyDatesGreater: + value: completed + readEmptyDatesLess: + value: completed + readEmptyDateFunDateFormats: + value: completed - name: StartTime in: query description: 'Only include calls that started on this date. Specify a date @@ -12390,6 +13415,11 @@ paths: schema: type: string format: date-time + examples: + readFullPage1: + value: '2008-01-02' + readFullPage2: + value: '2008-01-02' - name: StartTime< in: query description: 'Only include calls that started on this date. Specify a date @@ -12400,6 +13430,11 @@ paths: schema: type: string format: date-time + examples: + readEmptyDatesLess: + value: '2008-01-02' + readEmptyDateFunDateFormats: + value: 06/11/2019 22:05:25 MST - name: StartTime> in: query description: 'Only include calls that started on this date. Specify a date @@ -12410,6 +13445,9 @@ paths: schema: type: string format: date-time + examples: + readEmptyDatesGreater: + value: '2008-01-02' - name: EndTime in: query description: 'Only include calls that ended on this date. Specify a date as @@ -12420,6 +13458,11 @@ paths: schema: type: string format: date-time + examples: + readFullPage1: + value: '2009-01-02' + readFullPage2: + value: '2009-01-02' - name: EndTime< in: query description: 'Only include calls that ended on this date. Specify a date as @@ -12430,6 +13473,11 @@ paths: schema: type: string format: date-time + examples: + readEmptyDatesLess: + value: '2009-01-02' + readEmptyDateFunDateFormats: + value: '2019-06-11 22:05:25.000' - name: EndTime> in: query description: 'Only include calls that ended on this date. Specify a date as @@ -12440,6 +13488,9 @@ paths: schema: type: string format: date-time + examples: + readEmptyDatesGreater: + value: '2009-01-02' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -12464,41 +13515,246 @@ paths: content: application/json: schema: - type: object - title: ListCallResponse - properties: - calls: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListCallResponse + properties: + calls: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call' + examples: + readFullPage1: + value: + calls: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: billingreferencetag1 + answered_by: machine_start + api_version: '2010-04-01' + caller_name: callerid1 + date_created: Fri, 18 Oct 2019 17:00:00 +0000 + date_updated: Fri, 18 Oct 2019 17:01:00 +0000 + direction: outbound-api + duration: '4' + end_time: Fri, 18 Oct 2019 17:03:00 +0000 + forwarded_from: calledvia1 + from: '+13051416799' + from_formatted: (305) 141-6799 + group_sid: GPdeadbeefdeadbeefdeadbeefdeadbeef + parent_call_sid: CAdeadbeefdeadbeefdeadbeefdeadbeef + phone_number_sid: PNdeadbeefdeadbeefdeadbeefdeadbeef + price: '-0.200' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Fri, 18 Oct 2019 17:02:00 +0000 + status: completed + subresource_uris: + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+13051913581' + to_formatted: (305) 191-3581 + trunk_sid: TKdeadbeefdeadbeefdeadbeefdeadbeef + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: billingreferencetag2 + answered_by: human + api_version: '2010-04-01' + caller_name: callerid2 + date_created: Fri, 18 Oct 2019 16:00:00 +0000 + date_updated: Fri, 18 Oct 2019 16:01:00 +0000 + direction: inbound + duration: '3' + end_time: Fri, 18 Oct 2019 16:03:00 +0000 + forwarded_from: calledvia2 + from: '+13051416798' + from_formatted: (305) 141-6798 + group_sid: GPdeadbeefdeadbeefdeadbeefdeadbeee + parent_call_sid: CAdeadbeefdeadbeefdeadbeefdeadbeee + phone_number_sid: PNdeadbeefdeadbeefdeadbeefdeadbeee + price: '-0.100' + price_unit: JPY + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0 + start_time: Fri, 18 Oct 2019 16:02:00 +0000 + status: completed + subresource_uris: + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Recordings.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessages.json + to: '+13051913580' + to_formatted: (305) 191-3580 + trunk_sid: TKdeadbeefdeadbeefdeadbeefdeadbeef + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0.json + queue_time: '1000' + end: 1 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&From=%2B987654321&StartTime=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EndTime=2009-01-02&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&From=%2B987654321&StartTime=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EndTime=2009-01-02&PageSize=2&Page=1&PageToken=PACAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0 + page: 0 + page_size: 2 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&From=%2B987654321&StartTime=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EndTime=2009-01-02&PageSize=2&Page=0 + readFullPage2: + value: + calls: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: billingreferencetag1 + answered_by: machine_start + api_version: '2010-04-01' + caller_name: callerid1 + date_created: Fri, 18 Oct 2019 17:00:00 +0000 + date_updated: Fri, 18 Oct 2019 17:01:00 +0000 + direction: outbound-api + duration: '4' + end_time: Fri, 18 Oct 2019 17:03:00 +0000 + forwarded_from: calledvia1 + from: '+13051416799' + from_formatted: (305) 141-6799 + group_sid: GPdeadbeefdeadbeefdeadbeefdeadbeef + parent_call_sid: CAdeadbeefdeadbeefdeadbeefdeadbeef + phone_number_sid: PNdeadbeefdeadbeefdeadbeefdeadbeef + price: '-0.200' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Fri, 18 Oct 2019 17:02:00 +0000 + status: completed + subresource_uris: + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+13051913581' + to_formatted: (305) 191-3581 + trunk_sid: TKdeadbeefdeadbeefdeadbeefdeadbeef + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: billingreferencetag2 + answered_by: human + api_version: '2010-04-01' + caller_name: callerid2 + date_created: Fri, 18 Oct 2019 16:00:00 +0000 + date_updated: Fri, 18 Oct 2019 16:01:00 +0000 + direction: inbound + duration: '3' + end_time: Fri, 18 Oct 2019 16:03:00 +0000 + forwarded_from: calledvia2 + from: '+13051416798' + from_formatted: (305) 141-6798 + group_sid: GPdeadbeefdeadbeefdeadbeefdeadbeee + parent_call_sid: CAdeadbeefdeadbeefdeadbeefdeadbeee + phone_number_sid: PNdeadbeefdeadbeefdeadbeefdeadbeee + price: '-0.100' + price_unit: JPY + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0 + start_time: Fri, 18 Oct 2019 16:02:00 +0000 + status: completed + subresource_uris: + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Recordings.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0/UserDefinedMessages.json + to: '+13051913580' + to_formatted: (305) 191-3580 + trunk_sid: TKdeadbeefdeadbeefdeadbeefdeadbeef + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0.json + queue_time: '1000' + end: 3 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=2&PageToken=PACAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0 + page: 1 + page_size: 2 + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=0&PageToken=PBCAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 2 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&From=%2B987654321&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&To=%2B123456789&StartTime=2008-01-02&EndTime=2009-01-02&PageSize=2&Page=1&PageToken=PACAdeadbeefdeadbeefdeadbeefdeadbeef + readEmptyDatesGreater: + value: + calls: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&EndTime%3E=2009-01-02&From=%2B987654321&StartTime%3E=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=2&Page=0 + next_page_uri: null + page: 0 + page_size: 2 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?Status=completed&To=%2B123456789&EndTime%3E=2009-01-02&From=%2B987654321&StartTime%3E=2008-01-02&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=2&Page=0 + readEmptyDatesLess: + value: + calls: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2009-01-02&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=2008-01-02&PageSize=2&Page=0 + next_page_uri: null + page: 0 + page_size: 2 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2009-01-02&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=2008-01-02&PageSize=2&Page=0 + readEmptyDateFunDateFormats: + value: + calls: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0 + next_page_uri: null + page: 0 + page_size: 2 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls.json?EndTime%3C=2019-06-11+22%3A05%3A25.000&Status=completed&From=%2B987654321&To=%2B123456789&ParentCallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartTime%3C=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=2&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCall - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json: servers: - url: https://api.twilio.com @@ -12511,7 +13767,6 @@ paths: - to - status - start_time - pathType: instance dependentProperties: recording: '{account_sid: account_sid, call_sid: sid}' notification: '{account_sid: account_sid, call_sid: sid}' @@ -12523,6 +13778,7 @@ paths: user_defined_message_subscription: '{account_sid: account_sid, call_sid: sid}' user_defined_message: '{account_sid: account_sid, call_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance delete: description: Delete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs. @@ -12553,8 +13809,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCall - x-maturity: - - GA get: description: Fetch the call specified by the provided Call SID parameters: @@ -12583,12 +13837,50 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: billingreferencetag + answered_by: machine_start + api_version: '2010-04-01' + caller_name: callerid + date_created: Fri, 18 Oct 2019 17:00:00 +0000 + date_updated: Fri, 18 Oct 2019 17:01:00 +0000 + direction: outbound-api + duration: '4' + end_time: Fri, 18 Oct 2019 17:03:00 +0000 + forwarded_from: calledvia + from: '+13051416799' + from_formatted: (305) 141-6799 + group_sid: GPdeadbeefdeadbeefdeadbeefdeadbeef + parent_call_sid: CAdeadbeefdeadbeefdeadbeefdeadbeef + phone_number_sid: PNdeadbeefdeadbeefdeadbeefdeadbeef + price: '-0.200' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Fri, 18 Oct 2019 17:02:00 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+13051913581' + to_formatted: (305) 191-3581 + trunk_sid: TKdeadbeefdeadbeefdeadbeefdeadbeef + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' description: OK security: - accountSid_authToken: [] operationId: FetchCall - x-maturity: - - GA post: description: Initiates a call redirect or terminates a call parameters: @@ -12618,12 +13910,167 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: completed + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+14158675309' + to_formatted: (415) 867-5309 + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' + cancel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: canceled + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+14158675309' + to_formatted: (415) 867-5309 + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' + posttwiml: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: canceled + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+14158675309' + to_formatted: (415) 867-5309 + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' + updatetimelimit: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + annotation: null + answered_by: null + api_version: '2010-04-01' + caller_name: null + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + date_updated: Tue, 31 Aug 2010 20:36:44 +0000 + direction: inbound + duration: '15' + end_time: Tue, 31 Aug 2010 20:36:44 +0000 + forwarded_from: '+141586753093' + from: '+14158675308' + from_formatted: (415) 867-5308 + group_sid: null + parent_call_sid: null + phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + price: '-0.03000' + price_unit: USD + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start_time: Tue, 31 Aug 2010 20:36:29 +0000 + status: canceled + subresource_uris: + notifications: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Feedback.json + feedback_summaries: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/FeedbackSummary.json + payments: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json + events: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json + siprec: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json + streams: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json + user_defined_message_subscriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json + user_defined_messages: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json + to: '+14158675309' + to_formatted: (415) 867-5309 + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + queue_time: '1000' description: OK security: - accountSid_authToken: [] operationId: UpdateCall - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -12712,6 +14159,38 @@ paths: type: integer description: The maximum duration of the call in seconds. Constraints depend on account and configuration. + examples: + update: + value: + FallbackMethod: GET + FallbackUrl: https://example.com + Method: GET + Status: completed + StatusCallback: https://example.com + StatusCallbackUrl: https://example.com + StatusCallbackMethod: GET + Url: https://example.com + cancel: + value: + FallbackMethod: GET + FallbackUrl: https://example.com + Method: GET + Status: canceled + StatusCallback: https://example.com + StatusCallbackMethod: GET + Url: https://example.com + posttwiml: + value: + FallbackMethod: GET + FallbackUrl: https://example.com + Method: GET + Status: canceled + StatusCallback: https://example.com + StatusCallbackMethod: GET + Twiml: Enjoy + updatetimelimit: + value: + TimeLimit: 600 /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Events.json: servers: - url: https://api.twilio.com @@ -12721,8 +14200,8 @@ paths: defaultOutputProperties: - request - response - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list get: description: Retrieve a list of all events for a call. parameters: @@ -12768,41 +14247,84 @@ paths: content: application/json: schema: - type: object - title: ListCallEventResponse - properties: - events: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call.call_event' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListCallEventResponse + properties: + events: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call.call_event' + examples: + readFull: + value: + events: + - request: + method: POST + url: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + parameters: + status_callback_method: POST + twiml: Hi! + trim: trim-silence + timeout: '55' + method: POST + from: '+987654321' + to: '+123456789' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + machine_detection_timeout: '0' + response: + response_code: 201 + request_duration: 50 + content_type: application/json + response_body: '{"sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + date_created: Tue, 11 Aug 2020 17:44:08 +0000 + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 + readEmpty: + value: + events: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCallEvent - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Feedback.json: servers: - url: https://api.twilio.com @@ -12813,8 +14335,8 @@ paths: - sid - quality_score - date_created - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance get: description: Fetch a Feedback resource from a call parameters: @@ -12843,12 +14365,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 20 Aug 2015 21:45:46 +0000 + date_updated: Thu, 20 Aug 2015 21:45:46 +0000 + issues: + - imperfect-audio + - post-dial-delay + quality_score: 1 + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCallFeedback - x-maturity: - - GA post: description: Update a Feedback resource for a call parameters: @@ -12874,12 +14405,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 20 Aug 2015 21:45:46 +0000 + date_updated: Thu, 20 Aug 2015 21:45:46 +0000 + issues: + - audio-latency + quality_score: 2 + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCallFeedback - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -12901,6 +14440,12 @@ paths: issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.' + examples: + update: + value: + Issue: + - audio-latency + QualityScore: 2 /2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json: servers: - url: https://api.twilio.com @@ -12913,9 +14458,9 @@ paths: - call_feedback_count - quality_score_average - start_date - pathType: list parent: /Accounts/{AccountSid}/Calls.json mountName: feedback_summaries + pathType: list post: description: Create a FeedbackSummary resource for a call parameters: @@ -12935,12 +14480,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback_summary' + examples: + create: + value: + include_subaccounts: false + call_feedback_count: 729 + quality_score_standard_deviation: '1.0' + end_date: '2014-01-01' + quality_score_median: '4.0' + quality_score_average: '4.5' + date_updated: Tue, 31 Aug 2010 20:36:28 +0000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + call_count: 10200 + sid: FSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + start_date: '2014-01-01' + issues: + - count: 45 + description: imperfect-audio + percentage_of_total_calls: 0.04% description: Created security: - accountSid_authToken: [] operationId: CreateCallFeedbackSummary - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -12984,6 +14547,14 @@ paths: required: - StartDate - EndDate + examples: + create: + value: + EndDate: '2014-01-01' + IncludeSubaccounts: 'false' + StartDate: '2014-01-01' + StatusCallback: https://example.com + StatusCallbackMethod: GET /2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json: servers: - url: https://api.twilio.com @@ -12996,9 +14567,9 @@ paths: - call_feedback_count - quality_score_average - start_date - pathType: instance parent: /Accounts/{AccountSid}/Calls.json mountName: feedback_summaries + pathType: instance get: description: Fetch a FeedbackSummary resource from a call parameters: @@ -13027,12 +14598,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback_summary' + examples: + fetch: + value: + include_subaccounts: false + call_feedback_count: 729 + quality_score_standard_deviation: '1.0' + end_date: '2014-01-01' + quality_score_median: '4.0' + quality_score_average: '4.5' + date_updated: Tue, 31 Aug 2010 20:36:28 +0000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + call_count: 10200 + sid: FSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 31 Aug 2010 20:36:28 +0000 + start_date: '2014-01-01' + issues: + - count: 45 + description: imperfect-audio + percentage_of_total_calls: 0.04% description: OK security: - accountSid_authToken: [] operationId: FetchCallFeedbackSummary - x-maturity: - - GA delete: description: Delete a FeedbackSummary resource from a call parameters: @@ -13061,8 +14650,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCallFeedbackSummary - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json: servers: - url: https://api.twilio.com @@ -13073,8 +14660,8 @@ paths: - call_sid - error_code - message_date - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance get: description: '' parameters: @@ -13114,12 +14701,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_notification-instance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 18 Aug 2015 08:46:56 +0000 + date_updated: Tue, 18 Aug 2015 08:46:57 +0000 + error_code: '15003' + log: '1' + message_date: Tue, 18 Aug 2015 08:46:56 +0000 + message_text: statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml + more_info: https://www.twilio.com/docs/errors/15003 + request_method: null + request_url: '' + request_variables: '' + response_body: '' + response_headers: '' + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchCallNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json: servers: - url: https://api.twilio.com @@ -13130,8 +14735,8 @@ paths: - call_sid - error_code - message_date - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list get: description: '' parameters: @@ -13162,6 +14767,11 @@ paths: By default, all notifications are read.' schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 - name: MessageDate in: query description: Only show notifications for the specified date, formatted as @@ -13171,6 +14781,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: MessageDate< in: query description: Only show notifications for the specified date, formatted as @@ -13213,41 +14828,79 @@ paths: content: application/json: schema: - type: object - title: ListCallNotificationResponse - properties: - notifications: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call.call_notification' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListCallNotificationResponse + properties: + notifications: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call.call_notification' + examples: + readFull: + value: + notifications: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Tue, 18 Aug 2015 08:46:56 +0000 + date_updated: Tue, 18 Aug 2015 08:46:57 +0000 + error_code: '15003' + log: '1' + message_date: Tue, 18 Aug 2015 08:46:56 +0000 + message_text: statusCallback=http%3A%2F%2Fexample.com%2Ffoo.xml&ErrorCode=15003&LogLevel=WARN&Msg=Got+HTTP+404+response+to+http%3A%2F%2Fexample.com%2Ffoo.xml + more_info: https://www.twilio.com/docs/errors/15003 + request_method: null + request_url: '' + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + page: 0 + page_size: 50 + previous_page_uri: null + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + next_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json + readEmpty: + value: + notifications: [] + page: 0 + page_size: 50 + previous_page_uri: null + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + next_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json description: OK security: - accountSid_authToken: [] operationId: ListCallNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json: servers: - url: https://api.twilio.com @@ -13260,8 +14913,8 @@ paths: - status - start_time - duration - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a recording for the call parameters: @@ -13291,12 +14944,31 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:34 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: null + price_unit: null + duration: null + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartCallRecordingAPI + status: in-progress + error_code: null + encryption_details: null + track: both + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateCallRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13350,6 +15022,19 @@ paths: the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.' + examples: + create: + value: + RecordingStatusCallbackEvent: + - in-progress completed failed + RecordingStatusCallback: https://example.com + RecordingStatusCallbackMethod: GET + Trim: do-not-trim + RecordingChannels: dual + RecordingTrack: both + PlayBeep: true + Transcribe: true + TranscriptionConfiguration: JVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of recordings belonging to the call used to make the request @@ -13384,6 +15069,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: DateCreated< in: query description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the @@ -13394,6 +15084,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' - name: DateCreated> in: query description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the @@ -13404,6 +15099,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -13428,41 +15128,86 @@ paths: content: application/json: schema: - type: object - title: ListCallRecordingResponse - properties: - recordings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.call.call_recording' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListCallRecordingResponse + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + source: StartCallRecordingAPI + status: completed + track: both + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCallRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json: servers: - url: https://api.twilio.com @@ -13475,8 +15220,8 @@ paths: - status - start_time - duration - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: 'Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current @@ -13515,12 +15260,31 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:36 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: null + price_unit: null + duration: null + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartCallRecordingAPI + status: paused + error_code: null + encryption_details: null + track: both + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateCallRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13542,6 +15306,12 @@ paths: only applies when setting `status` is set to `paused`.' required: - Status + examples: + update: + value: + Status: paused + PauseBehavior: skip + PlayBeep: true get: description: Fetch an instance of a recording for a call parameters: @@ -13581,12 +15351,34 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: null + channels: 2 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + source: StartCallRecordingAPI + status: completed + error_code: null + track: both + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchCallRecording - x-maturity: - - GA delete: description: Delete a recording from your account parameters: @@ -13626,8 +15418,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCallRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json: servers: - url: https://api.twilio.com @@ -13637,11 +15427,11 @@ paths: - sid - friendly_name - status - pathType: instance dependentProperties: participant: '{account_sid: account_sid, conference_sid: sid}' recording: '{account_sid: account_sid, conference_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a conference parameters: @@ -13671,12 +15461,75 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference' + examples: + fetchValidMixerZone: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: us1 + status: completed + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: last-participant-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchValidRegionInProgress: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: au1 + status: in-progress + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: null + call_sid_ending_conference: null + fetchWithoutMixerZoneIntegerStatus: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: us1 + status: completed + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchUnknownMixerZoneInitIntegerStatus: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Fri, 18 Feb 2011 19:26:50 +0000 + date_updated: Fri, 18 Feb 2011 19:27:33 +0000 + friendly_name: AHH YEAH + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + region: unknown + status: init + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConference - x-maturity: - - GA post: description: '' parameters: @@ -13703,12 +15556,43 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference' + examples: + updateEndConference: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 22 Aug 2011 20:58:45 +0000 + date_updated: Mon, 22 Aug 2011 20:58:46 +0000 + friendly_name: null + region: us1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: conference-ended-via-api + call_sid_ending_conference: null + announceToConference: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: Mon, 08 Feb 2021 20:58:45 +0000 + date_updated: Mon, 08 Feb 2021 20:58:46 +0000 + friendly_name: MyRoom + region: us1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + reason_conference_ended: null + call_sid_ending_conference: null description: OK security: - accountSid_authToken: [] operationId: UpdateConference - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13741,6 +15625,13 @@ paths: - DELETE description: 'The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`' + examples: + updateEndConference: + value: + Status: completed + announceToConference: + value: + AnnounceUrl: http://www.myapp.com/announce /2010-04-01/Accounts/{AccountSid}/Conferences.json: servers: - url: https://api.twilio.com @@ -13750,11 +15641,11 @@ paths: - sid - friendly_name - status - pathType: list dependentProperties: participant: '{account_sid: account_sid, conference_sid: sid}' recording: '{account_sid: account_sid, conference_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of conferences belonging to the account used to make the request @@ -13778,6 +15669,15 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2008-01-03' + readNext: + value: '2008-01-03' + readPrevious: + value: '2008-01-03' + readDateCreatedEquals: + value: '2020-07-07' - name: DateCreated< in: query description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources @@ -13787,6 +15687,13 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2008-01-01' + readNext: + value: '2008-01-01' + readPrevious: + value: '2008-01-01' - name: DateCreated> in: query description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources @@ -13796,6 +15703,15 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2008-01-02' + readNext: + value: '2008-01-02' + readPrevious: + value: '2008-01-02' + readDateCreatedOnOrAfter: + value: '2021-01-01' - name: DateUpdated in: query description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources @@ -13805,6 +15721,13 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2018-11-13' + readNext: + value: '2018-11-13' + readPrevious: + value: '2018-11-13' - name: DateUpdated< in: query description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources @@ -13814,6 +15737,13 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2018-11-11' + readNext: + value: '2018-11-11' + readPrevious: + value: '2018-11-11' - name: DateUpdated> in: query description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources @@ -13823,11 +15753,27 @@ paths: schema: type: string format: date + examples: + readEmpty: + value: '2018-11-12' + readNext: + value: '2018-11-12' + readPrevious: + value: '2018-11-12' - name: FriendlyName in: query description: The string that identifies the Conference resources to read. schema: type: string + examples: + readEmpty: + value: friendly_name + readNext: + value: friendly_name + readPrevious: + value: friendly_name + readMyroom: + value: MyRoom - name: Status in: query description: 'The status of the resources to read. Can be: `init`, `in-progress`, @@ -13835,6 +15781,15 @@ paths: schema: type: string $ref: '#/components/schemas/conference_enum_status' + examples: + readEmpty: + value: init + readNext: + value: in-progress + readPrevious: + value: in-progress + readDateCreatedOnOrAfter: + value: in-progress - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -13859,42 +15814,373 @@ paths: content: application/json: schema: - type: object - title: ListConferenceResponse - properties: - conferences: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.conference' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListConferenceResponse + properties: + conferences: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.conference' + examples: + readEmpty: + value: + conferences: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=init&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=50&Page=0 + page: 0 + page_size: 50 + start: 0 + end: 0 + readNext: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFdddddddddddddddddddddddddddddddd + date_updated: Thu, 01 Jan 2015 10:23:45 +0000 + date_created: Thu, 01 Jan 2015 10:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFdddddddddddddddddddddddddddddddd.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: unknown + sid: CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + date_updated: Thu, 01 Jan 2015 09:23:45 +0000 + date_created: Thu, 01 Jan 2015 09:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: us1 + sid: CFffffffffffffffffffffffffffffffff + date_updated: Thu, 01 Jan 2015 08:23:45 +0000 + date_created: Thu, 01 Jan 2015 08:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFffffffffffffffffffffffffffffffff.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=2&PageToken=PACFffffffffffffffffffffffffffffffff + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + page: 1 + page_size: 3 + start: 3 + end: 5 + readPrevious: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Sat, 03 Jan 2015 11:23:45 +0000 + date_created: Sat, 03 Jan 2015 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: unknown + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Fri, 02 Jan 2015 11:23:45 +0000 + date_created: Fri, 02 Jan 2015 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: us1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Thu, 01 Jan 2015 11:23:45 +0000 + date_created: Thu, 01 Jan 2015 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateUpdated%3E=2018-11-12&DateUpdated%3C=2018-11-11&DateCreated=2008-01-03&FriendlyName=friendly_name&DateUpdated=2018-11-13&DateCreated%3C=2008-01-01&DateCreated%3E=2008-01-02&PageSize=3&Page=0&PageToken=PBCFdddddddddddddddddddddddddddddddd + page: 0 + page_size: 3 + start: 0 + end: 2 + readMyroom: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Sun, 03 Jan 2021 11:23:45 +0000 + date_created: Sun, 03 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: completed + region: us1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Sat, 02 Jan 2021 11:23:45 +0000 + date_created: Sat, 02 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: last-participant-left + call_sid_ending_conference: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + - status: completed + region: ie1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: last-participant-left + call_sid_ending_conference: CAcccccccccccccccccccccccccccccccc + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0 + page: 0 + page_size: 20 + start: 0 + end: 2 + readFull: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Fri, 03 Jul 2020 11:23:45 +0000 + date_created: Fri, 03 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: de1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Thu, 02 Jul 2020 11:23:45 +0000 + date_created: Thu, 02 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: completed + region: br1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Wed, 01 Jul 2020 11:23:45 +0000 + date_created: Wed, 01 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: FRIEND + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0 + page: 0 + page_size: 3 + start: 0 + end: 2 + readDateCreatedEquals: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Tue, 07 Jul 2020 11:23:45 +0000 + date_created: Tue, 07 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: de1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Tue, 07 Jul 2020 11:23:45 +0000 + date_created: Tue, 07 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: completed + region: br1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Tue, 07 Jul 2020 11:23:45 +0000 + date_created: Tue, 07 Jul 2020 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: FRIEND + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: participant-with-end-conference-on-exit-left + call_sid_ending_conference: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0 + page: 0 + page_size: 3 + start: 0 + end: 2 + readDateCreatedOnOrAfter: + value: + conferences: + - status: in-progress + region: jp1 + sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + friendly_name: friendly_name + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: de1 + sid: CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json + friendly_name: MyRoom + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + - status: in-progress + region: br1 + sid: CFcccccccccccccccccccccccccccccccc + date_updated: Fri, 01 Jan 2021 11:23:45 +0000 + date_created: Fri, 01 Jan 2021 11:23:45 +0000 + subresource_uris: + participants: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json + recordings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json + friendly_name: FRIEND + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json + api_version: '2010-04-01' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason_conference_ended: null + call_sid_ending_conference: null + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0 + page: 0 + page_size: 20 + start: 0 + end: 2 description: OK security: - accountSid_authToken: [] operationId: ListConference - x-maturity: - - GA - /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json: + /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json: servers: - url: https://api.twilio.com description: Recordings of conferences @@ -13905,8 +16191,193 @@ paths: - status - start_time - duration - pathType: instance parent: /Accounts/{AccountSid}/Conferences/{Sid}.json + pathType: list + get: + description: Retrieve a list of recordings belonging to the call used to make + the request + parameters: + - name: AccountSid + in: path + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Conference Recording resources to read. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + required: true + - name: ConferenceSid + in: path + description: The Conference SID that identifies the conference associated + with the recording to read. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CF[0-9a-fA-F]{32}$ + required: true + - name: DateCreated + in: query + description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the + resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` + will return recordings generated at or before midnight on a given date, + and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight + on a date.' + schema: + type: string + format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' + - name: DateCreated< + in: query + description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the + resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` + will return recordings generated at or before midnight on a given date, + and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight + on a date.' + schema: + type: string + format: date + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' + - name: DateCreated> + in: query + description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the + resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` + will return recordings generated at or before midnight on a given date, + and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight + on a date.' + schema: + type: string + format: date + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListConferenceRecordingResponse + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + recordings: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=50&Page=0 + description: OK + security: + - accountSid_authToken: [] + operationId: ListConferenceRecording + /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json: + servers: + - url: https://api.twilio.com + description: Recordings of conferences + x-twilio: + defaultOutputProperties: + - sid + - conference_sid + - status + - start_time + - duration + parent: /Accounts/{AccountSid}/Conferences/{Sid}.json + pathType: instance post: description: 'Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.' @@ -13945,12 +16416,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:39 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: null + price_unit: null + duration: null + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: paused + error_code: null + encryption_details: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateConferenceRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -13972,6 +16461,12 @@ paths: only applies when setting `status` is set to `paused`.' required: - Status + examples: + update: + value: + Status: paused + PauseBehavior: skip + PlayBeep: true get: description: Fetch an instance of a recording for a call parameters: @@ -14011,12 +16506,33 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.0025' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchConferenceRecording - x-maturity: - - GA delete: description: Delete a recording from your account parameters: @@ -14056,134 +16572,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConferenceRecording - x-maturity: - - GA - /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json: - servers: - - url: https://api.twilio.com - description: Recordings of conferences - x-twilio: - defaultOutputProperties: - - sid - - conference_sid - - status - - start_time - - duration - pathType: list - parent: /Accounts/{AccountSid}/Conferences/{Sid}.json - get: - description: Retrieve a list of recordings belonging to the call used to make - the request - parameters: - - name: AccountSid - in: path - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the Conference Recording resources to read. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - required: true - - name: ConferenceSid - in: path - description: The Conference SID that identifies the conference associated - with the recording to read. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^CF[0-9a-fA-F]{32}$ - required: true - - name: DateCreated - in: query - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the - resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` - will return recordings generated at or before midnight on a given date, - and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight - on a date.' - schema: - type: string - format: date - - name: DateCreated< - in: query - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the - resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` - will return recordings generated at or before midnight on a given date, - and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight - on a date.' - schema: - type: string - format: date - - name: DateCreated> - in: query - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the - resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` - will return recordings generated at or before midnight on a given date, - and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight - on a date.' - schema: - type: string - format: date - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListConferenceRecordingResponse - properties: - recordings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri - description: OK - security: - - accountSid_authToken: [] - operationId: ListConferenceRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json: servers: - url: https://api.twilio.com @@ -14192,8 +16580,8 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a connect-app parameters: @@ -14223,12 +16611,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.connect_app' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + authorize_redirect_url: http://example.com/redirect + company_name: Twilio + deauthorize_callback_method: GET + deauthorize_callback_url: http://example.com/deauth + description: null + friendly_name: Connect app for deletion + homepage_url: http://example.com/home + permissions: [] + sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchConnectApp - x-maturity: - - GA post: description: Update a connect-app with the specified parameters parameters: @@ -14258,12 +16658,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.connect_app' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + authorize_redirect_url: http://example.com/redirect + company_name: Twilio + deauthorize_callback_method: GET + deauthorize_callback_url: http://example.com/deauth + description: null + friendly_name: Connect app for deletion + homepage_url: http://example.com/home + permissions: [] + sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateConnectApp - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -14315,6 +16727,18 @@ paths: description: 'A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`.' + examples: + update: + value: + AuthorizeRedirectUrl: https://example.com + CompanyName: company_name + DeauthorizeCallbackMethod: GET + DeauthorizeCallbackUrl: https://example.com + Description: description + FriendlyName: friendly_name + HomepageUrl: https://example.com + Permissions: + - get-all delete: description: Delete an instance of a connect-app parameters: @@ -14344,8 +16768,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/ConnectApps.json: servers: - url: https://api.twilio.com @@ -14354,8 +16776,8 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of connect-apps belonging to the account used to make the request @@ -14394,41 +16816,76 @@ paths: content: application/json: schema: - type: object - title: ListConnectAppResponse - properties: - connect_apps: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.connect_app' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListConnectAppResponse + properties: + connect_apps: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.connect_app' + examples: + readFull: + value: + connect_apps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + authorize_redirect_url: http://example.com/redirect + company_name: Twilio + deauthorize_callback_method: GET + deauthorize_callback_url: http://example.com/deauth + description: null + friendly_name: Connect app for deletion + homepage_url: http://example.com/home + permissions: [] + sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json + readEmpty: + value: + connect_apps: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json description: OK security: - accountSid_authToken: [] operationId: ListConnectApp - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json: servers: - url: https://api.twilio.com @@ -14438,8 +16895,8 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/Addresses/{Sid}.json + pathType: list get: description: '' parameters: @@ -14486,41 +16943,90 @@ paths: content: application/json: schema: - type: object - title: ListDependentPhoneNumberResponse - properties: - dependent_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListDependentPhoneNumberResponse + properties: + dependent_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' + examples: + readFull: + value: + dependent_phone_numbers: + - sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: '3197004499318' + phone_number: '+3197004499318' + voice_url: null + voice_method: POST + voice_fallback_url: null + voice_fallback_method: POST + voice_caller_id_lookup: false + date_created: Thu, 23 Feb 2017 10:26:31 -0800 + date_updated: Thu, 23 Feb 2017 10:26:31 -0800 + sms_url: '' + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + address_requirements: any + capabilities: + Voice: false + SMS: true + MMS: false + status_callback: '' + status_callback_method: POST + api_version: '2010-04-01' + voice_application_sid: null + sms_application_sid: '' + trunk_sid: null + emergency_status: Inactive + emergency_address_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json + readEmpty: + value: + dependent_phone_numbers: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentPhoneNumbers.json description: OK security: - accountSid_authToken: [] operationId: ListDependentPhoneNumber - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json: servers: - url: https://api.twilio.com @@ -14530,10 +17036,10 @@ paths: - sid - phone_number - friendly_name - pathType: instance dependentProperties: assigned_add_on: '{account_sid: account_sid, resource_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance post: description: Update an incoming-phone-number instance. parameters: @@ -14564,12 +17070,53 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Inactive + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: true + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + voice_receive_mode: voice + status: in-use + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json description: OK security: - accountSid_authToken: [] operationId: UpdateIncomingPhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -14756,6 +17303,31 @@ paths: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. + examples: + update: + value: + AccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + EmergencyStatus: Inactive + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + VoiceReceiveMode: voice + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Fetch an incoming-phone-number belonging to the account used to make the request. @@ -14786,12 +17358,53 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + voice_receive_mode: voice + status: in-use + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json description: OK security: - accountSid_authToken: [] operationId: FetchIncomingPhoneNumber - x-maturity: - - GA delete: description: Delete a phone-numbers belonging to the account used to make the request. @@ -14822,8 +17435,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIncomingPhoneNumber - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json: servers: - url: https://api.twilio.com @@ -14833,10 +17444,10 @@ paths: - sid - phone_number - friendly_name - pathType: list dependentProperties: assigned_add_on: '{account_sid: account_sid, resource_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of incoming-phone-numbers belonging to the account used to make the request. @@ -14857,12 +17468,22 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the IncomingPhoneNumber resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -14870,6 +17491,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -14900,41 +17526,105 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListIncomingPhoneNumberResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumber - x-maturity: - - GA post: description: Purchase a phone-number for the account. parameters: @@ -14954,12 +17644,53 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: false + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + subresource_uris: + assigned_add_ons: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -15153,6 +17884,31 @@ paths: an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only). + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa x-twilio: conditional: - - phone_number @@ -15160,18 +17916,18 @@ paths: /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - description - pathType: instance dependentProperties: assigned_add_on_extension: '{account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: sid}' parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json + pathType: instance get: description: Fetch an instance of an Add-on installation currently assigned to this Number. @@ -15211,12 +17967,26 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + examples: + fetch: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: Thu, 07 Apr 2016 23:52:28 +0000 + date_updated: Thu, 07 Apr 2016 23:52:28 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + extensions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json description: OK security: - accountSid_authToken: [] operationId: FetchIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta delete: description: Remove the assignment of an Add-on installation from the Number specified. @@ -15256,23 +18026,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - description - pathType: list dependentProperties: assigned_add_on_extension: '{account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: sid}' parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json + pathType: list get: description: Retrieve a list of Add-on installations currently assigned to this Number. @@ -15320,41 +18088,78 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberAssignedAddOnResponse - properties: - assigned_add_ons: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListIncomingPhoneNumberAssignedAddOnResponse + properties: + assigned_add_ons: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + assigned_add_ons: + - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: Thu, 07 Apr 2016 23:52:28 +0000 + date_updated: Thu, 07 Apr 2016 23:52:28 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + extensions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + assigned_add_ons: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta post: description: Assign an Add-on installation to the Number specified. parameters: @@ -15383,12 +18188,26 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + examples: + create: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: Thu, 07 Apr 2016 23:52:28 +0000 + date_updated: Thu, 07 Apr 2016 23:52:28 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + extensions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberAssignedAddOn - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -15404,19 +18223,23 @@ paths: description: The SID that identifies the Add-on installation. required: - InstalledAddOnSid + examples: + create: + value: + InstalledAddOnSid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ? /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json : servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - product_name - pathType: instance parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json className: assigned_add_on_extension + pathType: instance get: description: Fetch an instance of an Extension for the Assigned Add-on. parameters: @@ -15464,25 +18287,35 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + enabled: true description: OK security: - accountSid_authToken: [] operationId: FetchIncomingPhoneNumberAssignedAddOnExtension - x-maturity: - - Beta /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - product_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json className: assigned_add_on_extension + pathType: list get: description: Retrieve a list of Extensions for the Assigned Add-on. parameters: @@ -15538,41 +18371,74 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberAssignedAddOnExtensionResponse - properties: - extensions: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListIncomingPhoneNumberAssignedAddOnExtensionResponse + properties: + extensions: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + extensions: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AssignedAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberAssignedAddOnExtension - x-maturity: - - Beta /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json: servers: - url: https://api.twilio.com @@ -15582,8 +18448,8 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json + pathType: list get: description: '' parameters: @@ -15603,11 +18469,21 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -15615,6 +18491,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -15645,41 +18526,102 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberLocalResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListIncomingPhoneNumberLocalResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + mms: true + sms: false + voice: true + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Local.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberLocal - x-maturity: - - GA post: description: '' parameters: @@ -15699,12 +18641,51 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: true + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberLocal - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -15893,6 +18874,31 @@ paths: Regulations. required: - PhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json: servers: - url: https://api.twilio.com @@ -15902,8 +18908,8 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json + pathType: list get: description: '' parameters: @@ -15923,11 +18929,21 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -15935,6 +18951,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -15965,41 +18986,102 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberMobileResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListIncomingPhoneNumberMobileResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + mms: true + sms: false + voice: true + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/Mobile.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberMobile - x-maturity: - - GA post: description: '' parameters: @@ -16019,12 +19101,51 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: true + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberMobile - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16212,6 +19333,31 @@ paths: Regulations. required: - PhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json: servers: - url: https://api.twilio.com @@ -16221,8 +19367,8 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json + pathType: list get: description: '' parameters: @@ -16242,11 +19388,21 @@ paths: Can be: `true` or `false` and the default is `true`.' schema: type: boolean + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: FriendlyName in: query description: A string that identifies the resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -16254,6 +19410,11 @@ paths: schema: type: string format: phone-number + examples: + readFull: + value: '+19876543210' + readEmpty: + value: '+19876543210' - name: Origin in: query description: 'Whether to include phone numbers based on their origin. Can @@ -16284,41 +19445,102 @@ paths: content: application/json: schema: - type: object - title: ListIncomingPhoneNumberTollFreeResponse - properties: - incoming_phone_numbers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListIncomingPhoneNumberTollFreeResponse + properties: + incoming_phone_numbers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: null + capabilities: + mms: true + sms: false + voice: true + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: (808) 925-5327 + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: '' + sms_fallback_method: POST + sms_fallback_url: '' + sms_method: POST + sms_url: '' + status_callback: '' + status_callback_method: POST + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: '' + voice_caller_id_lookup: false + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_url: null + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 + incoming_phone_numbers: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/TollFree.json?FriendlyName=friendly_name&Beta=true&PhoneNumber=%2B19876543210&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIncomingPhoneNumberTollFree - x-maturity: - - GA post: description: '' parameters: @@ -16338,12 +19560,51 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + beta: false + capabilities: + voice: true + sms: false + mms: true + fax: false + date_created: Thu, 30 Jul 2015 23:19:04 +0000 + date_updated: Thu, 30 Jul 2015 23:19:04 +0000 + emergency_status: Active + emergency_address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_address_status: registered + friendly_name: friendly_name + identity_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + origin: origin + phone_number: '+18089255327' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: GET + sms_fallback_url: https://example.com + sms_method: GET + sms_url: https://example.com + status_callback: https://example.com + status_callback_method: GET + trunk_sid: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_caller_id_lookup: true + voice_fallback_method: GET + voice_fallback_url: https://example.com + voice_method: GET + voice_url: https://example.com + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_receive_mode: voice + status: in-use description: Created security: - accountSid_authToken: [] operationId: CreateIncomingPhoneNumberTollFree - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16531,6 +19792,31 @@ paths: Regulations. required: - PhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ApiVersion: api_version + AreaCode: area_code + EmergencyStatus: Active + EmergencyAddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + IdentitySid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + PhoneNumber: '+18089255327' + SmsApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com + StatusCallback: https://example.com + StatusCallbackMethod: GET + VoiceApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VoiceCallerIdLookup: 'true' + VoiceFallbackMethod: GET + VoiceFallbackUrl: https://example.com + VoiceMethod: GET + VoiceUrl: https://example.com + BundleSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json: servers: - url: https://api.twilio.com @@ -16540,8 +19826,8 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: '' parameters: @@ -16571,12 +19857,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.key' + examples: + fetch: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: FetchKey - x-maturity: - - GA post: description: '' parameters: @@ -16606,12 +19897,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.key' + examples: + update: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: UpdateKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16623,6 +19919,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: foo delete: description: '' parameters: @@ -16652,8 +19952,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteKey - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Keys.json: servers: - url: https://api.twilio.com @@ -16663,8 +19961,8 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: '' parameters: @@ -16702,41 +20000,69 @@ paths: content: application/json: schema: - type: object - title: ListKeyResponse - properties: - keys: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.key' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListKeyResponse + properties: + keys: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.key' + examples: + readFull: + value: + keys: + - sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readEmpty: + value: + keys: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListKey - x-maturity: - - GA post: description: '' parameters: @@ -16756,12 +20082,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.new_key' + examples: + create: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + secret: foobar description: Created security: - accountSid_authToken: [] operationId: CreateNewKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -16773,6 +20105,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + create: + value: + FriendlyName: foo x-twilio: mountName: new_keys /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json: @@ -16785,8 +20121,8 @@ paths: - sid - parent_sid - content_type - pathType: instance parent: /Accounts/{AccountSid}/Messages/{Sid}.json + pathType: instance delete: description: Delete media from your account. Once delete, you will no longer be billed @@ -16827,8 +20163,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMedia - x-maturity: - - GA get: description: Fetch a single media instance belonging to the account used to make the request @@ -16869,12 +20203,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message.media' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: image/jpeg + date_created: Sun, 16 Aug 2015 15:53:54 +0000 + date_updated: Sun, 16 Aug 2015 15:53:55 +0000 + parent_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchMedia - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json: servers: - url: https://api.twilio.com @@ -16885,8 +20227,8 @@ paths: - sid - parent_sid - content_type - pathType: list parent: /Accounts/{AccountSid}/Messages/{Sid}.json + pathType: list get: description: Retrieve a list of Media resources belonging to the account used to make the request @@ -16921,6 +20263,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: DateCreated< in: query description: 'Only include media that was created on this date. Specify a @@ -16931,6 +20278,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' - name: DateCreated> in: query description: 'Only include media that was created on this date. Specify a @@ -16941,6 +20293,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -16965,41 +20322,78 @@ paths: content: application/json: schema: - type: object - title: ListMediaResponse - properties: - media_list: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.message.media' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListMediaResponse + properties: + media_list: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.message.media' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + media_list: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: image/jpeg + date_created: Sun, 16 Aug 2015 15:53:54 +0000 + date_updated: Sun, 16 Aug 2015 15:53:55 +0000 + parent_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media/MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 + media_list: [] + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListMedia - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json: servers: - url: https://api.twilio.com @@ -17010,8 +20404,8 @@ paths: - date_enqueued - position - wait_time - pathType: instance parent: /Accounts/{AccountSid}/Queues/{Sid}.json + pathType: instance get: description: Fetch a specific member from the queue parameters: @@ -17047,12 +20441,27 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue.member' + examples: + fetch: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Tue, 07 Aug 2012 22:57:41 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 + fetchFront: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Tue, 07 Aug 2012 22:57:41 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA post: description: Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @@ -17089,12 +20498,27 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue.member' + examples: + update: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Thu, 06 Dec 2018 18:42:47 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 + dequeueFront: + value: + queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Tue, 07 Aug 2012 22:57:41 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 143 description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17121,6 +20545,15 @@ paths: form data and `GET` sends the data as query parameters. required: - Url + examples: + update: + value: + Method: GET + Url: https://example.com + dequeueFront: + value: + Method: GET + Url: https://example.com /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json: servers: - url: https://api.twilio.com @@ -17131,8 +20564,8 @@ paths: - date_enqueued - position - wait_time - pathType: list parent: /Accounts/{AccountSid}/Queues/{Sid}.json + pathType: list get: description: Retrieve the members of the queue parameters: @@ -17179,41 +20612,71 @@ paths: content: application/json: schema: - type: object - title: ListMemberResponse - properties: - queue_members: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.queue.member' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListMemberResponse + properties: + queue_members: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.queue.member' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + queue_members: + - queue_sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_enqueued: Mon, 17 Dec 2018 18:36:39 +0000 + position: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + wait_time: 124 + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?Page=0&PageSize=50 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + queue_members: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Messages.json: servers: - url: https://api.twilio.com @@ -17226,11 +20689,11 @@ paths: - status - direction - date_sent - pathType: list dependentProperties: media: '{account_sid: account_sid, message_sid: sid}' feedback: '{account_sid: account_sid, message_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list post: description: Send a message from the account used to make the request parameters: @@ -17250,12 +20713,181 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+14155552345' + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+14155552345' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWoService: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+14155552345' + messaging_service_sid: null + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: {} + to: '+14155552345' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithMessagingService: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: {} + to: '+14155552345' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithQueuedStatus: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Thu, 30 Jul 2015 20:12:31 +0000 + date_sent: Thu, 30 Jul 2015 20:12:33 +0000 + date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+14155552345' + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '1' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: {} + to: '+14155552345' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createScheduledMessageSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Mon, 29 Nov 2021 22:40:10 +0000 + date_sent: null + date_updated: Mon, 29 Nov 2021 22:40:10 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '0' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: {} + to: '+15558675310' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createScheduledMessageMms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Mon, 29 Nov 2021 22:40:10 +0000 + date_sent: null + date_updated: Mon, 29 Nov 2021 22:40:10 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '1' + num_segments: '1' + price: null + price_unit: null + sid: MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: {} + to: '+15558675310' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createScheduledMessageWhatsapp: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: "Hello! \U0001F44D" + date_created: Mon, 29 Nov 2021 22:40:10 +0000 + date_sent: null + date_updated: Mon, 29 Nov 2021 22:40:10 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + num_media: '0' + num_segments: '0' + price: null + price_unit: null + sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json + tags: {} + to: whatsapp:+15558675310 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17367,15 +20999,6 @@ paths: type: boolean description: If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media. - ContentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HX[0-9a-fA-F]{32}$ - description: The SID of the Content object returned at Content API - content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). - If this parameter is not specified, then the Content API will - not be utilized. ContentVariables: type: string description: Key-value pairs of variable names to substitution values, @@ -17421,14 +21044,121 @@ paths: provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada. + ContentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + description: The SID of the Content object returned at Content API + content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). + If this parameter is not specified, then the Content API will + not be utilized. required: - To + examples: + create: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + From: '+14155552345' + MediaUrl: + - https://c1.staticflickr.com/3/2899/14341091933_1e92e62d12_b.jpg + PersistentAction: + - mailto:test@example.com + TransientAction: + - reply:Tell me more + StatusCallback: https://example.com + To: '+14155552345' + Title: An exciting example + RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": + "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' + TrafficType: free + Tags: '{"campaign_name": "Spring Sale 2022","message_type": "cart_abandoned"}' + createWoService: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + From: '+14155552345' + MediaUrl: + - https://example.com + PersistentAction: + - mailto:test@example.com + TransientAction: + - reply:Tell me more + StatusCallback: https://example.com + To: '+14155552345' + Title: An exciting example + RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": + "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' + TrafficType: free + createWithMessagingService: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MediaUrl: + - https://example.com + PersistentAction: + - mailto:test@example.com + TransientAction: + - reply:Tell me more + StatusCallback: https://example.com + To: '+14155552345' + Title: An exciting example + RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": + "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' + ContentSid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ContentVariables: '{"1": "name","2": "owl.png"}' + TrafficType: free + createWithQueuedStatus: + value: + ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Body: "Hello! \U0001F44D" + From: '+14155552345' + MediaUrl: + - https://example.com + PersistentAction: + - mailto:test@example.com + TransientAction: + - reply:Tell me more + StatusCallback: https://example.com + To: '+14155552345' + Title: An exciting example + RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": + "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' + TrafficType: free + createScheduledMessageSms: + value: + Body: "Hello! \U0001F44D" + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ScheduleType: fixed + SendAt: '2021-11-29T23:50:00Z' + StatusCallback: https://example.com + To: '+15558675310' + createScheduledMessageMms: + value: + Body: "Hello! \U0001F44D" + MediaUrl: https://example.com + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ScheduleType: fixed + SendAt: '2021-11-29T23:50:00Z' + StatusCallback: https://example.com + To: '+15558675310' + createScheduledMessageWhatsapp: + value: + Body: "Hello! \U0001F44D" + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ScheduleType: fixed + SendAt: '2021-11-29T23:50:00Z' + StatusCallback: https://example.com + To: whatsapp:+15558675310 x-twilio: conditional: - - from - messaging_service_sid - - body - media_url + - content_sid get: description: Retrieve a list of messages belonging to the account used to make the request @@ -17449,6 +21179,21 @@ paths: schema: type: string format: phone-number + examples: + readFullPage1: + value: '+123456789' + readEmptySentdateLess: + value: '+123456789' + readEmptySentdateEquals: + value: '+123456789' + readEmptySentdateGreater: + value: '+123456789' + readEmptySentdateGreaterFormat1: + value: '+123456789' + readEmptySentdateGreaterFormat2: + value: '+123456789' + readEmptySentdateGreaterFormat3: + value: '+123456789' - name: From in: query description: Read messages sent from only this phone number or alphanumeric @@ -17456,6 +21201,21 @@ paths: schema: type: string format: phone-number + examples: + readFullPage1: + value: '+987654321' + readEmptySentdateLess: + value: '+987654321' + readEmptySentdateEquals: + value: '+987654321' + readEmptySentdateGreater: + value: '+987654321' + readEmptySentdateGreaterFormat1: + value: '+987654321' + readEmptySentdateGreaterFormat2: + value: '+987654321' + readEmptySentdateGreaterFormat3: + value: '+987654321' - name: DateSent in: query description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` @@ -17466,6 +21226,9 @@ paths: schema: type: string format: date-time + examples: + readEmptySentdateEquals: + value: '2008-01-02' - name: DateSent< in: query description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` @@ -17476,6 +21239,9 @@ paths: schema: type: string format: date-time + examples: + readEmptySentdateLess: + value: '2008-01-02' - name: DateSent> in: query description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` @@ -17486,6 +21252,17 @@ paths: schema: type: string format: date-time + examples: + readFullPage1: + value: '2008-01-02' + readEmptySentdateGreater: + value: '2008-01-02' + readEmptySentdateGreaterFormat1: + value: 06/11/2019 22:05:25 MST + readEmptySentdateGreaterFormat2: + value: '2019-06-11 22:05:25.000' + readEmptySentdateGreaterFormat3: + value: Wed, 19 Jun 2019 22:04:00 -0000 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -17510,41 +21287,170 @@ paths: content: application/json: schema: - type: object - title: ListMessageResponse - properties: - messages: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.message' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListMessageResponse + properties: + messages: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.message' + examples: + readFullPage1: + value: + end: 1 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=1&PageToken=PAMMc26223853f8c46b4ab7dfaa6abba0a26 + page: 0 + page_size: 2 + previous_page_uri: null + messages: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: testing + date_created: Fri, 24 May 2019 17:44:46 +0000 + date_sent: Fri, 24 May 2019 17:44:50 +0000 + date_updated: Fri, 24 May 2019 17:44:50 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+12019235161' + messaging_service_sid: null + num_media: '0' + num_segments: '1' + price: '-0.00750' + price_unit: USD + sid: SMded05904ccb347238880ca9264e8fe1c + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c/Feedback.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMded05904ccb347238880ca9264e8fe1c.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: look mom I have media! + date_created: Fri, 24 May 2019 17:44:46 +0000 + date_sent: Fri, 24 May 2019 17:44:49 +0000 + date_updated: Fri, 24 May 2019 17:44:49 +0000 + direction: inbound + error_code: 30004 + error_message: Message blocked + from: '+12019235161' + messaging_service_sid: null + num_media: '3' + num_segments: '1' + price: '-0.00750' + price_unit: USD + sid: MMc26223853f8c46b4ab7dfaa6abba0a26 + status: received + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26/Feedback.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMc26223853f8c46b4ab7dfaa6abba0a26.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=2&Page=0 + readEmptySentdateLess: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3C=2008-01-02&PageSize=25&Page=0 + readEmptySentdateEquals: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent=2008-01-02&PageSize=25&Page=0 + readEmptySentdateGreater: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2008-01-02&PageSize=25&Page=0 + readEmptySentdateGreaterFormat1: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=06%2F11%2F2019+22%3A05%3A25+MST&PageSize=25&Page=0 + readEmptySentdateGreaterFormat2: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=2019-06-11+22%3A05%3A25.000&PageSize=25&Page=0 + readEmptySentdateGreaterFormat3: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0 + next_page_uri: null + page: 0 + page_size: 25 + previous_page_uri: null + messages: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json?To=%2B123456789&From=%2B987654321&DateSent%3E=Wed%2C+19+Jun+2019+22%3A04%3A00+-0000&PageSize=25&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json: servers: - url: https://api.twilio.com @@ -17557,11 +21463,11 @@ paths: - status - direction - date_sent - pathType: instance dependentProperties: media: '{account_sid: account_sid, message_sid: sid}' feedback: '{account_sid: account_sid, message_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance delete: description: Deletes a message record from your account parameters: @@ -17591,8 +21497,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA get: description: Fetch a message belonging to the account used to make the request parameters: @@ -17622,12 +21526,38 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: testing + date_created: Fri, 24 May 2019 17:18:27 +0000 + date_sent: Fri, 24 May 2019 17:18:28 +0000 + date_updated: Fri, 24 May 2019 17:18:28 +0000 + direction: outbound-api + error_code: 30007 + error_message: Carrier violation + from: '+12019235161' + messaging_service_sid: MGdeadbeefdeadbeefdeadbeefdeadbeef + num_media: '0' + num_segments: '1' + price: '-0.00750' + price_unit: USD + sid: SMb7c0a2ce80504485a6f653a7110836f5 + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json + tags: + campaign_name: Spring Sale 2022 + message_type: cart_abandoned + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA post: description: To redact a message-body from a post-flight message record, post to the message instance resource with an empty body @@ -17658,12 +21588,61 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' + examples: + redactBody: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: '' + date_created: Fri, 24 May 2019 17:18:27 +0000 + date_sent: Fri, 24 May 2019 17:18:28 +0000 + date_updated: Fri, 24 May 2019 17:18:28 +0000 + direction: outbound-api + error_code: null + error_message: null + from: '+12019235161' + messaging_service_sid: MGdeadbeefdeadbeefdeadbeefdeadbeef + num_media: '0' + num_segments: '1' + price: null + price_unit: USD + sid: SMb7c0a2ce80504485a6f653a7110836f5 + status: sent + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json + tags: {} + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json + cancelMessage: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + body: Hello World! + date_created: Fri, 24 May 2019 17:18:27 +0000 + date_sent: null + date_updated: Fri, 24 May 2019 18:18:28 +0000 + direction: outbound-api + error_code: null + error_message: null + from: null + messaging_service_sid: MGdeadbeefdeadbeefdeadbeefdeadbeef + num_media: '0' + num_segments: '1' + price: null + price_unit: USD + sid: SMb7c0a2ce80504485a6f653a7110836f5 + status: canceled + subresource_uris: + media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Media.json + feedback: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5/Feedback.json + tags: {} + to: '+18182008801' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMb7c0a2ce80504485a6f653a7110836f5.json description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17680,6 +21659,13 @@ paths: $ref: '#/components/schemas/message_enum_update_status' description: When set as `canceled`, allows a message cancelation request if a message has not yet been sent. + examples: + redactBody: + value: + Body: '' + cancelMessage: + value: + Status: canceled /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json: servers: - url: https://api.twilio.com @@ -17689,8 +21675,8 @@ paths: - message_sid - outcome - date_created - pathType: list parent: /Accounts/{AccountSid}/Messages/{Sid}.json + pathType: list post: description: '' parameters: @@ -17719,12 +21705,19 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message.message_feedback' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + message_sid: MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outcome: confirmed + uri: uri description: Created security: - accountSid_authToken: [] operationId: CreateMessageFeedback - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17740,6 +21733,10 @@ paths: POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.' + examples: + create: + value: + Outcome: confirmed /2010-04-01/Accounts/{AccountSid}/SigningKeys.json: servers: - url: https://api.twilio.com @@ -17749,8 +21746,8 @@ paths: - sid - friendly_name - secret - pathType: list parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new Signing Key for the account making the request. parameters: @@ -17770,12 +21767,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.new_signing_key' + examples: + create: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + secret: foobar description: Created security: - accountSid_authToken: [] operationId: CreateNewSigningKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -17787,6 +21790,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + create: + value: + FriendlyName: foo x-twilio: mountName: new_signing_keys get: @@ -17825,41 +21832,69 @@ paths: content: application/json: schema: - type: object - title: ListSigningKeyResponse - properties: - signing_keys: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.signing_key' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSigningKeyResponse + properties: + signing_keys: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.signing_key' + examples: + readFull: + value: + signing_keys: + - sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readEmpty: + value: + signing_keys: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SigningKeys.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSigningKey - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json: servers: - url: https://api.twilio.com @@ -17870,8 +21905,8 @@ paths: - call_sid - error_code - message_date - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch a notification belonging to the account used to make the request @@ -17902,12 +21937,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.notification-instance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 13 Sep 2010 20:02:01 +0000 + date_updated: Mon, 13 Sep 2010 20:02:01 +0000 + error_code: '11200' + log: '0' + message_date: Mon, 13 Sep 2010 20:02:00 +0000 + message_text: EmailNotification=false&LogLevel=ERROR&sourceComponent=12000&Msg=&httpResponse=500&ErrorCode=11200&url=http%3A%2F%2Fvoiceforms4000.appspot.com%2Ftwiml + more_info: http://www.twilio.com/docs/errors/11200 + request_method: get + request_url: https://voiceforms4000.appspot.com/twiml/9436/question/0 + request_variables: AccountSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CallStatus=in-progress&ToZip=94937&ToCity=INVERNESS&ToState=CA&Called=%2B14156694923&To=%2B14156694923&ToCountry=US&CalledZip=94937&Direction=inbound&ApiVersion=2010-04-01&Caller=%2B17378742833&CalledCity=INVERNESS&CalledCountry=US&CallSid=CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CalledState=CA&From=%2B17378742833 + response_body: Response body from your webhook URL as a string. + response_headers: Date=Mon%2C+13+Sep+2010+20%3A02%3A00+GMT&Content-Length=466&Connection=close&Content-Type=text%2Fhtml%3B+charset%3DUTF-8&Server=Google+Frontend + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Notifications.json: servers: - url: https://api.twilio.com @@ -17918,8 +21971,8 @@ paths: - call_sid - error_code - message_date - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of notifications belonging to the account used to make the request @@ -17941,6 +21994,11 @@ paths: By default, all notifications are read.' schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 - name: MessageDate in: query description: Only show notifications for the specified date, formatted as @@ -17950,6 +22008,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: MessageDate< in: query description: Only show notifications for the specified date, formatted as @@ -17992,41 +22055,79 @@ paths: content: application/json: schema: - type: object - title: ListNotificationResponse - properties: - notifications: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.notification' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListNotificationResponse + properties: + notifications: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.notification' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + previous_page_uri: null + next_page_uri: null + notifications: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Apr 2015 16:47:33 +0000 + date_updated: Thu, 30 Apr 2015 16:47:35 +0000 + error_code: '21609' + log: '1' + message_date: Thu, 30 Apr 2015 16:47:32 +0000 + message_text: LogLevel=WARN&invalidStatusCallbackUrl=&Msg=Invalid+Url+for+callSid%3A+CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+invalid+statusCallbackUrl%3A+&ErrorCode=21609 + more_info: https://www.twilio.com/docs/errors/21609 + request_method: null + request_url: '' + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + page: 0 + page_size: 1 + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 + next_page_uri: null + notifications: [] + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListNotification - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json: servers: - url: https://api.twilio.com @@ -18038,8 +22139,8 @@ paths: - sid - phone_number - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an outgoing-caller-id belonging to the account used to make the request @@ -18070,12 +22171,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: (415) 867-5309 + phone_number: '+141586753096' + date_created: Fri, 21 Aug 2009 00:11:24 +0000 + date_updated: Fri, 21 Aug 2009 00:11:24 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchOutgoingCallerId - x-maturity: - - GA post: description: Updates the caller-id parameters: @@ -18105,12 +22214,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 21 Aug 2009 00:11:24 +0000 + date_updated: Fri, 21 Aug 2009 00:11:24 +0000 + friendly_name: friendly_name + phone_number: '+141586753096' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateOutgoingCallerId - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18122,6 +22239,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + FriendlyName: friendly_name delete: description: Delete the caller-id specified from the account parameters: @@ -18151,8 +22272,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteOutgoingCallerId - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json: servers: - url: https://api.twilio.com @@ -18164,8 +22283,8 @@ paths: - sid - phone_number - friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of outgoing-caller-ids belonging to the account used to make the request @@ -18216,41 +22335,72 @@ paths: content: application/json: schema: - type: object - title: ListOutgoingCallerIdResponse - properties: - outgoing_caller_ids: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListOutgoingCallerIdResponse + properties: + outgoing_caller_ids: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 + next_page_uri: null + outgoing_caller_ids: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 21 Aug 2009 00:11:24 +0000 + date_updated: Fri, 21 Aug 2009 00:11:24 +0000 + friendly_name: (415) 867-5309 + phone_number: '+141586753096' + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 + next_page_uri: null + outgoing_caller_ids: [] + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OutgoingCallerIds.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListOutgoingCallerId - x-maturity: - - GA post: description: '' parameters: @@ -18270,12 +22420,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.validation_request' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + phone_number: '+18001234567' + validation_code: '111111' description: Created security: - accountSid_authToken: [] operationId: CreateValidationRequest - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18323,6 +22479,15 @@ paths: Can be: `GET` or `POST`, and the default is `POST`.' required: - PhoneNumber + examples: + create: + value: + CallDelay: 100 + Extension: extension + FriendlyName: friendly_name + PhoneNumber: '+18001234567' + StatusCallback: http://www.example.com + StatusCallbackMethod: GET x-twilio: mountName: validation_requests /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json: @@ -18336,8 +22501,8 @@ paths: - status - muted - hold - pathType: instance parent: /Accounts/{AccountSid}/Conferences/{Sid}.json + pathType: instance get: description: Fetch an instance of a participant parameters: @@ -18375,12 +22540,43 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + fetchByLabel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchParticipant - x-maturity: - - GA post: description: Update the properties of the participant parameters: @@ -18418,12 +22614,107 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + muteParticipant: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + muteParticipantByLabel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + holdParticipantWithMusic: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: true + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + announceToParticipant: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + modifyParticipant: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: complete + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + modifyParticipantByLabel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: complete + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18524,6 +22815,28 @@ paths: description: The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. + examples: + muteParticipant: + value: + Muted: 'true' + muteParticipantByLabel: + value: + Muted: 'true' + holdParticipantWithMusic: + value: + Hold: 'true' + HoldUrl: http://www.myapp.com/hold + announceToParticipant: + value: + AnnounceUrl: http://www.myapp.com/announce + modifyParticipant: + value: + Coaching: true + CallSidToCoach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + modifyParticipantByLabel: + value: + Coaching: true + CallSidToCoach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb delete: description: Kick a participant from a given conference parameters: @@ -18561,8 +22874,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteParticipant - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json: servers: - url: https://api.twilio.com @@ -18574,8 +22885,8 @@ paths: - status - muted - hold - pathType: list parent: /Accounts/{AccountSid}/Conferences/{Sid}.json + pathType: list post: description: '' parameters: @@ -18601,12 +22912,187 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + createWithSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithSidAsCoach: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithNonE164Number: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameJitterBufferSize: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameByoc: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameCallerId: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + label: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameReason: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFriendlyNameRecordingTrack: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFromToClient: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithFromToSip: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: customer + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: false + hold: false + status: queued + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -18942,6 +23428,171 @@ paths: required: - From - To + examples: + createWithSid: + value: + From: '+17736774757' + To: '+14157663747' + Label: customer + EarlyMedia: true + Beep: onEnter + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + Trim: do-not-trim + TimeLimit: 3600 + MachineDetection: enable + MachineDetectionTimeout: 15 + MachineDetectionSpeechThreshold: 3000 + MachineDetectionSpeechEndThreshold: 3000 + MachineDetectionSilenceTimeout: 3000 + AmdStatusCallback: http://statuscallback.com + AmdStatusCallbackMethod: POST + MachineDetectionEngine: Lumenvox + MachineDetectionMinWordLength: 100 + MachineDetectionMaxWordLength: 5000 + MachineDetectionWordsSilence: 50 + MachineDetectionMaxNumOfWords: 5 + MachineDetectionSilenceThreshold: 256 + createWithFriendlyName: + value: + From: '+17736774757' + To: '+14157663747' + Label: customer + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + Trim: do-not-trim + TimeLimit: 3600 + MachineDetection: enable + MachineDetectionTimeout: 15 + MachineDetectionSpeechThreshold: 3000 + MachineDetectionSpeechEndThreshold: 3000 + MachineDetectionSilenceTimeout: 3000 + AmdStatusCallback: http://statuscallback.com + AmdStatusCallbackMethod: POST + createWithSidAsCoach: + value: + From: '+17736774757' + To: '+14157663747' + EarlyMedia: true + Beep: onEnter + Muted: false + CallSidToCoach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + createWithNonE164Number: + value: + From: '4405512345678' + To: '4157663747' + EarlyMedia: true + Beep: onEnter + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + createWithFriendlyNameJitterBufferSize: + value: + From: '+17736774757' + To: '+14157663747' + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + JitterBufferSize: small + createWithFriendlyNameByoc: + value: + From: '+17736774757' + To: '+14157663747' + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + Byoc: BYbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + createWithFriendlyNameCallerId: + value: + From: '+17736774757' + To: '+14157663747' + CallerId: '+17736772737' + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + createWithFriendlyNameReason: + value: + From: '+17736774757' + To: '+14157663747' + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + CallReason: Reason for the call (Beta) + createWithFriendlyNameRecordingTrack: + value: + From: '+17736774757' + To: '+14157663747' + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + RecordingTrack: inbound + createWithFromToClient: + value: + From: client:alice + To: client:bob + Label: customer + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 + createWithFromToSip: + value: + From: alice + To: sip:bob@twilio.com + Label: customer + EarlyMedia: true + Beep: 'false' + Muted: false + StatusCallback: https://myapp.com/events + StatusCallbackMethod: POST + StatusCallbackEvent: ringing + Record: true + TimeLimit: 3600 get: description: Retrieve a list of participants belonging to the account used to make the request @@ -18971,12 +23622,22 @@ paths: `true` or `false`.' schema: type: boolean + examples: + readFull: + value: 'true' + readNext: + value: 'true' + readPrevious: + value: 'true' - name: Hold in: query description: 'Whether to return only participants that are on hold. Can be: `true` or `false`.' schema: type: boolean + examples: + readEmpty: + value: true - name: Coaching in: query description: 'Whether to return only participants who are coaching another @@ -19007,41 +23668,171 @@ paths: content: application/json: schema: - type: object - title: ListParticipantResponse - properties: - participants: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.conference.participant' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListParticipantResponse + properties: + participants: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.conference.participant' + examples: + readEmpty: + value: + participants: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0 + next_page_uri: null + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Hold=True&PageSize=50&Page=0 + page: 0 + page_size: 50 + end: 0 + start: 0 + readFull: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Sat, 19 Feb 2011 21:07:19 +0000 + date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Sat, 19 Feb 2011 21:07:19 +0000 + date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + page: 0 + page_size: 2 + start: 0 + end: 1 + readNext: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAcccccccccccccccccccccccccccccccc + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 17 Feb 2011 21:07:19 +0000 + date_updated: Thu, 17 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAcccccccccccccccccccccccccccccccc.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAdddddddddddddddddddddddddddddddd + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 16 Feb 2011 21:07:19 +0000 + date_updated: Wed, 16 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAdddddddddddddddddddddddddddddddd.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=2&PageToken=PACPdddddddddddddddddddddddddddddddd + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + page: 1 + page_size: 2 + start: 2 + end: 3 + readPrevious: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Sat, 19 Feb 2011 21:07:19 +0000 + date_updated: Sat, 19 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: true + call_sid_to_coach: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 18 Feb 2011 21:07:19 +0000 + date_updated: Fri, 18 Feb 2011 21:07:19 +0000 + end_conference_on_exit: false + muted: true + hold: false + status: connected + start_conference_on_enter: true + coaching: false + call_sid_to_coach: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=1&PageToken=PACPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json?Muted=true&PageSize=2&Page=0&PageToken=PBCPcccccccccccccccccccccccccccccccc + page: 0 + page_size: 2 + start: 0 + end: 1 description: OK security: - accountSid_authToken: [] operationId: ListParticipant - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json: servers: - url: https://api.twilio.com @@ -19050,8 +23841,8 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: create an instance of payments. This will start a new payments session @@ -19082,12 +23873,19 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.payments' + examples: + startPaymentSessionSuccess: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreatePayments - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -19186,6 +23984,21 @@ paths: required: - IdempotencyKey - StatusCallback + examples: + startPaymentSessionSuccess: + value: + ChargeAmount: '12.00' + Currency: USD + Description: api testing + IdempotencyKey: abcd + Input: dtmf + Parameter: '{''name'':''foobar''}' + PaymentConnector: stripe_connector + PaymentMethod: credit-card + PostalCode: true + SecurityCode: true + StatusCallback: https://myapp.com/payments + ValidCardTypes: visa amex /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json: servers: - url: https://api.twilio.com @@ -19194,8 +24007,8 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: update an instance of payments with different phases of payment flows. @@ -19235,12 +24048,35 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.payments' + examples: + collectCreditCardNumber: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + collectCreditCardExpiryDate: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + completePayment: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + date_updated: Wed, 18 Dec 2019 20:02:01 +0000 + sid: PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Accepted security: - accountSid_authToken: [] operationId: UpdatePayments - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -19277,6 +24113,22 @@ paths: required: - IdempotencyKey - StatusCallback + examples: + collectCreditCardNumber: + value: + Capture: payment-card-number + IdempotencyKey: abcd + StatusCallback: https://myapp.com/payments + collectCreditCardExpiryDate: + value: + Capture: expiration-date + IdempotencyKey: abcd + StatusCallback: https://myapp.com/payments + completePayment: + value: + IdempotencyKey: abcd + Status: complete + StatusCallback: https://myapp.com/payments /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json: servers: - url: https://api.twilio.com @@ -19287,10 +24139,10 @@ paths: - friendly_name - current_size - average_wait_time - pathType: instance dependentProperties: member: '{account_sid: account_sid, queue_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a queue identified by the QueueSid parameters: @@ -19320,12 +24172,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: OK security: - accountSid_authToken: [] operationId: FetchQueue - x-maturity: - - GA post: description: Update the queue with the new parameters parameters: @@ -19355,12 +24219,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: OK security: - accountSid_authToken: [] operationId: UpdateQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -19376,6 +24252,11 @@ paths: type: integer description: The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. + examples: + update: + value: + FriendlyName: friendly_name + MaxSize: 1 delete: description: Remove an empty queue parameters: @@ -19405,8 +24286,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteQueue - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Queues.json: servers: - url: https://api.twilio.com @@ -19417,10 +24296,10 @@ paths: - friendly_name - current_size - average_wait_time - pathType: list dependentProperties: member: '{account_sid: account_sid, queue_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of queues belonging to the account used to make the request @@ -19459,41 +24338,76 @@ paths: content: application/json: schema: - type: object - title: ListQueueResponse - properties: - queues: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.queue' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListQueueResponse + properties: + queues: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.queue' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + queues: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + queues: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListQueue - x-maturity: - - GA post: description: Create a queue parameters: @@ -19513,12 +24427,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + average_wait_time: 0 + current_size: 0 + date_created: Tue, 04 Aug 2015 18:39:09 +0000 + date_updated: Tue, 04 Aug 2015 18:39:09 +0000 + friendly_name: '0.361280134646222' + max_size: 100 + sid: QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + members: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json description: Created security: - accountSid_authToken: [] operationId: CreateQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -19536,6 +24462,11 @@ paths: The default is 1000. The maximum is 5000. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name + MaxSize: 1 /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json: servers: - url: https://api.twilio.com @@ -19547,11 +24478,11 @@ paths: - status - start_time - duration - pathType: instance dependentProperties: transcription: '{account_sid: account_sid, recording_sid: sid}' add_on_result: '{account_sid: account_sid, reference_sid: sid}' parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a recording parameters: @@ -19582,18 +24513,72 @@ paths: period of 40 days. schema: type: boolean + examples: + fetchIncludeSoftDeleted: + value: 'true' responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '-0.00250' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchIncludeSoftDeleted: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Mon, 14 Feb 2022 22:23:00 +0100 + date_updated: Mon, 14 Feb 2022 22:23:00 +0100 + start_time: Mon, 14 Feb 2022 22:23:00 +0100 + price: '-0.00250' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: deleted + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRecording - x-maturity: - - GA delete: description: Delete a recording from your account parameters: @@ -19623,8 +24608,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings.json: servers: - url: https://api.twilio.com @@ -19636,11 +24619,11 @@ paths: - status - start_time - duration - pathType: list dependentProperties: transcription: '{account_sid: account_sid, recording_sid: sid}' add_on_result: '{account_sid: account_sid, reference_sid: sid}' parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of recordings belonging to the account used to make the request @@ -19666,6 +24649,13 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' + readIncludeSoftDeleted: + value: '2008-01-02' - name: DateCreated< in: query description: 'Only include recordings that were created on this date. Specify @@ -19677,6 +24667,13 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-01' + readEmpty: + value: '2008-01-01' + readIncludeSoftDeleted: + value: '2008-01-01' - name: DateCreated> in: query description: 'Only include recordings that were created on this date. Specify @@ -19688,6 +24685,13 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-03' + readEmpty: + value: '2008-01-03' + readIncludeSoftDeleted: + value: '2008-01-03' - name: CallSid in: query description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) @@ -19713,6 +24717,9 @@ paths: period of 40 days. schema: type: boolean + examples: + readIncludeSoftDeleted: + value: 'True' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -19737,41 +24744,148 @@ paths: content: application/json: schema: - type: object - title: ListRecordingResponse - properties: - recordings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListRecordingResponse + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 1 + date_created: Fri, 14 Oct 2016 21:56:34 +0000 + date_updated: Fri, 14 Oct 2016 21:56:38 +0000 + start_time: Fri, 14 Oct 2016 21:56:34 +0000 + price: '0.04' + price_unit: USD + duration: '4' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: StartConferenceRecordingAPI + status: completed + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + next_page_uri: null + page: 0 + page_size: 1 + previous_page_uri: null + recordings: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0 + readIncludeSoftDeleted: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0 + next_page_uri: null + page: 0 + page_size: 2 + previous_page_uri: null + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channels: 2 + date_created: Mon, 14 Feb 2022 22:23:00 +0100 + date_updated: Mon, 14 Feb 2022 22:23:00 +0100 + start_time: Mon, 14 Feb 2022 22:23:00 +0100 + price: '0.04' + price_unit: USD + duration: '6' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: OutboundAPI + status: deleted + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + channels: 2 + date_created: Mon, 14 Feb 2022 22:23:00 +0100 + date_updated: Mon, 14 Feb 2022 22:23:00 +0100 + start_time: Mon, 14 Feb 2022 22:23:00 +0000 + price: '0.04' + price_unit: USD + duration: '6' + sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + source: OutboundAPI + status: completed + error_code: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json + subresource_uris: + add_on_results: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json + transcriptions: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json + encryption_details: + encryption_public_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + encryption_cek: OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q== + encryption_iv: 8I2hhNIYNTrwxfHk + media_url: http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecording - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json: servers: - url: https://api.twilio.com @@ -19782,11 +24896,11 @@ paths: - status - add_on_sid - date_created - pathType: instance dependentProperties: payload: '{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: sid}' parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: instance get: description: Fetch an instance of an AddOnResult parameters: @@ -19825,12 +24939,24 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' + examples: + fetch: + value: + sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + date_completed: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + payloads: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json description: OK security: - accountSid_authToken: [] operationId: FetchRecordingAddOnResult - x-maturity: - - GA delete: description: Delete a result and purge all associated Payloads parameters: @@ -19869,8 +24995,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecordingAddOnResult - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json: servers: - url: https://api.twilio.com @@ -19881,11 +25005,11 @@ paths: - status - add_on_sid - date_created - pathType: list dependentProperties: payload: '{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: sid}' parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: list get: description: Retrieve a list of results belonging to the recording parameters: @@ -19932,41 +25056,76 @@ paths: content: application/json: schema: - type: object - title: ListRecordingAddOnResultResponse - properties: - add_on_results: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListRecordingAddOnResultResponse + properties: + add_on_results: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + add_on_results: + - sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + date_completed: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + payloads: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + add_on_results: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecordingAddOnResult - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json: servers: - url: https://api.twilio.com @@ -19976,12 +25135,11 @@ paths: - sid - label - content_type - pathType: instance dependentProperties: - api/v2010/recording_add_on_result_payload_data: '{account_sid: account_sid, - reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: - sid}' + data: '{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: + add_on_result_sid, payload_sid: sid}' parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + pathType: instance get: description: Fetch an instance of a result payload parameters: @@ -20030,12 +25188,25 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + examples: + fetch: + value: + sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: application/json + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json description: OK security: - accountSid_authToken: [] operationId: FetchRecordingAddOnResultPayload - x-maturity: - - GA delete: description: Delete a payload from the result along with all associated Data parameters: @@ -20084,8 +25255,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecordingAddOnResultPayload - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json: servers: - url: https://api.twilio.com @@ -20095,12 +25264,11 @@ paths: - sid - label - content_type - pathType: list dependentProperties: - api/v2010/recording_add_on_result_payload_data: '{account_sid: account_sid, - reference_sid: reference_sid, add_on_result_sid: add_on_result_sid, payload_sid: - sid}' + data: '{account_sid: account_sid, reference_sid: reference_sid, add_on_result_sid: + add_on_result_sid, payload_sid: sid}' parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json + pathType: list get: description: Retrieve a list of payloads belonging to the AddOnResult parameters: @@ -20157,41 +25325,77 @@ paths: content: application/json: schema: - type: object - title: ListRecordingAddOnResultPayloadResponse - properties: - payloads: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListRecordingAddOnResultPayloadResponse + properties: + payloads: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + payloads: + - sid: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reference_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_configuration_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + add_on_result_sid: XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + content_type: application/json + date_created: Wed, 01 Sep 2010 15:15:41 +0000 + date_updated: Wed, 01 Sep 2010 15:15:41 +0000 + subresource_uris: + data: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + payloads: [] + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecordingAddOnResultPayload - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -20202,8 +25406,8 @@ paths: - type - status - duration - pathType: instance parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: instance get: description: '' parameters: @@ -20243,12 +25447,26 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Mon, 22 Aug 2011 20:58:44 +0000 + date_updated: Mon, 22 Aug 2011 20:58:44 +0000 + duration: '10' + price: '0.00000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + transcription_text: THIS IS A TEST + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchRecordingTranscription - x-maturity: - - GA delete: description: '' parameters: @@ -20288,8 +25506,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecordingTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json: servers: - url: https://api.twilio.com @@ -20300,8 +25516,8 @@ paths: - type - status - duration - pathType: list parent: /Accounts/{AccountSid}/Recordings/{Sid}.json + pathType: list get: description: '' parameters: @@ -20349,41 +25565,84 @@ paths: content: application/json: schema: - type: object - title: ListRecordingTranscriptionResponse - properties: - transcriptions: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListRecordingTranscriptionResponse + properties: + transcriptions: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + transcriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Mon, 22 Aug 2011 20:58:44 +0000 + date_updated: Mon, 22 Aug 2011 20:58:44 +0000 + duration: '10' + price: '0.00000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + transcription_text: THIS IS A TEST + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + total: 1 + transcriptions: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListRecordingTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json: servers: - url: https://api.twilio.com @@ -20393,8 +25652,8 @@ paths: - sid - short_code - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a short code parameters: @@ -20424,12 +25683,25 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.short_code' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: null + date_updated: null + friendly_name: API_CLUSTER_TEST_SHORT_CODE + short_code: '99990' + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_url: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchShortCode - x-maturity: - - GA post: description: Update a short code with the following parameters parameters: @@ -20459,12 +25731,25 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.short_code' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: null + date_updated: null + friendly_name: API_CLUSTER_TEST_SHORT_CODE + short_code: '99990' + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_url: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateShortCode - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -20515,6 +25800,15 @@ paths: - DELETE description: 'The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.' + examples: + update: + value: + ApiVersion: api_version + FriendlyName: friendly_name + SmsFallbackMethod: GET + SmsFallbackUrl: https://example.com + SmsMethod: GET + SmsUrl: https://example.com /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json: servers: - url: https://api.twilio.com @@ -20524,8 +25818,8 @@ paths: - sid - short_code - friendly_name - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of short-codes belonging to the account used to make the request @@ -20545,12 +25839,22 @@ paths: description: The string that identifies the ShortCode resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: ShortCode in: query description: Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. schema: type: string + examples: + readFull: + value: short_code + readEmpty: + value: short_code - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -20575,51 +25879,93 @@ paths: content: application/json: schema: - type: object - title: ListShortCodeResponse - properties: - short_codes: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.short_code' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListShortCodeResponse + properties: + short_codes: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.short_code' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + short_codes: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + date_created: null + date_updated: null + friendly_name: API_CLUSTER_TEST_SHORT_CODE + short_code: '99990' + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_fallback_method: POST + sms_fallback_url: null + sms_method: POST + sms_url: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?Page=0&PageSize=50 + next_page_uri: null + num_pages: 1 + page: 0 + page_size: 50 + previous_page_uri: null + short_codes: [] + start: 0 + total: 1 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json description: OK security: - accountSid_authToken: [] operationId: ListShortCode - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: '' parameters: @@ -20647,12 +25993,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.signing_key' + examples: + fetch: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: FetchSigningKey - x-maturity: - - GA post: description: '' parameters: @@ -20680,12 +26031,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.signing_key' + examples: + update: + value: + sid: SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: foo + date_created: Mon, 13 Jun 2016 22:50:08 +0000 + date_updated: Mon, 13 Jun 2016 22:50:08 +0000 description: OK security: - accountSid_authToken: [] operationId: UpdateSigningKey - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -20696,6 +26052,10 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + FriendlyName: foo delete: description: '' parameters: @@ -20723,34 +26083,32 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSigningKey - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{Sid}.json + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json className: auth_types + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json className: auth_type_calls + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json: servers: - url: https://api.twilio.com @@ -20759,9 +26117,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_credential_list_mapping + pathType: list post: description: Create a new credential list mapping resource parameters: @@ -20790,12 +26148,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipAuthCallsCredentialListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -20812,6 +26176,10 @@ paths: SIP domain. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of credential list mappings belonging to the domain used in the request @@ -20859,41 +26227,70 @@ paths: content: application/json: schema: - type: object - title: ListSipAuthCallsCredentialListMappingResponse - properties: - contents: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipAuthCallsCredentialListMappingResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSipAuthCallsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -20902,9 +26299,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_credential_list_mapping + pathType: instance get: description: Fetch a specific instance of a credential list mapping parameters: @@ -20943,12 +26340,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipAuthCallsCredentialListMapping - x-maturity: - - GA delete: description: Delete a credential list mapping from the requested domain parameters: @@ -20987,8 +26390,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipAuthCallsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json: servers: - url: https://api.twilio.com @@ -20997,9 +26398,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_ip_access_control_list_mapping + pathType: list post: description: Create a new IP Access Control List mapping parameters: @@ -21028,12 +26429,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21050,6 +26457,10 @@ paths: to the SIP domain. required: - IpAccessControlListSid + examples: + create: + value: + IpAccessControlListSid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of IP Access Control List mappings belonging to the domain used in the request @@ -21097,41 +26508,70 @@ paths: content: application/json: schema: - type: object - title: ListSipAuthCallsIpAccessControlListMappingResponse - properties: - contents: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipAuthCallsIpAccessControlListMappingResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -21140,9 +26580,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls.json className: auth_calls_ip_access_control_list_mapping + pathType: instance get: description: Fetch a specific instance of an IP Access Control List mapping parameters: @@ -21181,12 +26621,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA delete: description: Delete an IP Access Control List mapping from the requested domain parameters: @@ -21225,17 +26671,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipAuthCallsIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth.json className: auth_type_registrations + pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json: servers: - url: https://api.twilio.com @@ -21244,9 +26688,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json className: auth_registrations_credential_list_mapping + pathType: list post: description: Create a new credential list mapping resource parameters: @@ -21275,12 +26719,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21297,6 +26747,10 @@ paths: SIP domain. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of credential list mappings belonging to the domain used in the request @@ -21344,41 +26798,70 @@ paths: content: application/json: schema: - type: object - title: ListSipAuthRegistrationsCredentialListMappingResponse - properties: - contents: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipAuthRegistrationsCredentialListMappingResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + examples: + readEmpty: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 + readFull: + value: + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + end: 0 + previous_page_uri: null + contents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Registrations/CredentialListMappings.json?PageSize=50&Page=0 + page_size: 50 + start: 0 + next_page_uri: null + page: 0 description: OK security: - accountSid_authToken: [] operationId: ListSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -21387,9 +26870,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json className: auth_registrations_credential_list_mapping + pathType: instance get: description: Fetch a specific instance of a credential list mapping parameters: @@ -21428,12 +26911,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Thu, 30 Jul 2015 20:00:00 +0000 + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA delete: description: Delete a credential list mapping from the requested domain parameters: @@ -21472,8 +26961,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipAuthRegistrationsCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json: servers: - url: https://api.twilio.com @@ -21483,8 +26970,8 @@ paths: - sid - username - credential_list_sid - pathType: list parent: /Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json + pathType: list get: description: Retrieve a list of credentials. parameters: @@ -21531,41 +27018,72 @@ paths: content: application/json: schema: - type: object - title: ListSipCredentialResponse - properties: - credentials: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipCredentialResponse + properties: + credentials: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + readFull: + value: + credentials: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: '1440013725.28' + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 + readEmpty: + value: + credentials: [] + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipCredential - x-maturity: - - GA post: description: Create a new credential resource. parameters: @@ -21594,12 +27112,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: '1440013725.28' description: Created security: - accountSid_authToken: [] operationId: CreateSipCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21621,6 +27147,11 @@ paths: required: - Username - Password + examples: + create: + value: + Password: password + Username: username /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json: servers: - url: https://api.twilio.com @@ -21630,8 +27161,8 @@ paths: - sid - username - credential_list_sid - pathType: instance parent: /Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json + pathType: instance get: description: Fetch a single credential. parameters: @@ -21669,12 +27200,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: '1440013725.28' description: OK security: - accountSid_authToken: [] operationId: FetchSipCredential - x-maturity: - - GA post: description: Update a credential resource. parameters: @@ -21712,12 +27251,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + credential_list_sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 19 Aug 2015 19:48:45 +0000 + date_updated: Wed, 19 Aug 2015 19:48:45 +0000 + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + username: username description: OK security: - accountSid_authToken: [] operationId: UpdateSipCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21730,6 +27277,10 @@ paths: description: The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) + examples: + update: + value: + Password: password delete: description: Delete a credential resource. parameters: @@ -21767,8 +27318,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipCredential - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json: servers: - url: https://api.twilio.com @@ -21777,10 +27326,10 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: credential: '{account_sid: account_sid, credential_list_sid: sid}' parent: /Accounts/{AccountSid}/SIP.json + pathType: list get: description: Get All Credential Lists parameters: @@ -21817,41 +27366,73 @@ paths: content: application/json: schema: - type: object - title: ListSipCredentialListResponse - properties: - credential_lists: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipCredentialListResponse + properties: + credential_lists: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + readFull: + value: + credential_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 + readEmpty: + value: + credential_lists: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipCredentialList - x-maturity: - - GA post: description: Create a Credential List parameters: @@ -21870,12 +27451,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipCredentialList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21889,6 +27479,10 @@ paths: CredentialList, up to 64 characters long. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json: servers: - url: https://api.twilio.com @@ -21897,10 +27491,10 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: credential: '{account_sid: account_sid, credential_list_sid: sid}' parent: /Accounts/{AccountSid}/SIP.json + pathType: instance get: description: Get a Credential List parameters: @@ -21928,12 +27522,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipCredentialList - x-maturity: - - GA post: description: Update a Credential List parameters: @@ -21961,12 +27564,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Low Rises + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credentials: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSipCredentialList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -21980,6 +27592,10 @@ paths: up to 64 characters long. required: - FriendlyName + examples: + update: + value: + FriendlyName: friendly_name delete: description: Delete a Credential List parameters: @@ -22007,8 +27623,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipCredentialList - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json: servers: - url: https://api.twilio.com @@ -22017,8 +27631,8 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: list post: description: Create a CredentialListMapping resource for an account. parameters: @@ -22048,12 +27662,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Production Gateways IP Address - Scranton + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipCredentialListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22070,6 +27692,10 @@ paths: CredentialList resource to map to the SIP domain. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Read multiple CredentialListMapping resources from an account. parameters: @@ -22117,41 +27743,72 @@ paths: content: application/json: schema: - type: object - title: ListSipCredentialListMappingResponse - properties: - credential_list_mappings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipCredentialListMappingResponse + properties: + credential_list_mappings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + examples: + readFull: + value: + credential_list_mappings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Production Gateways IP Address - Scranton + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 + readEmpty: + value: + credential_list_mappings: [] + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 + next_page_uri: null + start: 0 + end: 0 + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -22160,8 +27817,8 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: instance get: description: Fetch a single CredentialListMapping resource from an account. parameters: @@ -22201,12 +27858,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 11 Sep 2013 17:51:38 +0000 + date_updated: Wed, 11 Sep 2013 17:51:38 +0000 + friendly_name: Production Gateways IP Address - Scranton + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipCredentialListMapping - x-maturity: - - GA delete: description: Delete a CredentialListMapping resource from an account. parameters: @@ -22246,8 +27911,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipCredentialListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json: servers: - url: https://api.twilio.com @@ -22257,12 +27920,12 @@ paths: - sid - domain_name - friendly_name - pathType: list dependentProperties: ip_access_control_list_mapping: '{account_sid: account_sid, domain_sid: sid}' credential_list_mapping: '{account_sid: account_sid, domain_sid: sid}' auth_types: '{account_sid: account_sid, domain_sid: sid}' parent: /Accounts/{AccountSid}/SIP.json + pathType: list get: description: Retrieve a list of domains belonging to the account used to make the request @@ -22301,41 +27964,88 @@ paths: content: application/json: schema: - type: object - title: ListSipDomainResponse - properties: - domains: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipDomainResponse + properties: + domains: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + readFull: + value: + domains: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + start: 0 + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 + readEmpty: + value: + domains: [] + start: 0 + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipDomain - x-maturity: - - GA post: description: Create a new Domain parameters: @@ -22355,12 +28065,36 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSipDomain - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22460,6 +28194,22 @@ paths: for the emergency call. required: - DomainName + examples: + create: + value: + DomainName: dunder-mifflin-scranton.sip.twilio.com + FriendlyName: Scranton Office + VoiceFallbackMethod: POST + VoiceFallbackUrl: '' + VoiceMethod: POST + VoiceStatusCallbackMethod: POST + VoiceStatusCallbackUrl: '' + VoiceUrl: https://dundermifflin.example.com/twilio/app.php + SipRegistration: true + EmergencyCallingEnabled: true + Secure: true + ByocTrunkSid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EmergencyCallerSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json: servers: - url: https://api.twilio.com @@ -22469,12 +28219,12 @@ paths: - sid - domain_name - friendly_name - pathType: instance dependentProperties: ip_access_control_list_mapping: '{account_sid: account_sid, domain_sid: sid}' credential_list_mapping: '{account_sid: account_sid, domain_sid: sid}' auth_types: '{account_sid: account_sid, domain_sid: sid}' parent: /Accounts/{AccountSid}/SIP.json + pathType: instance get: description: Fetch an instance of a Domain parameters: @@ -22504,12 +28254,36 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSipDomain - x-maturity: - - GA post: description: Update the attributes of a domain parameters: @@ -22539,12 +28313,36 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + auth_type: IP_ACL + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + domain_name: dunder-mifflin-scranton.sip.twilio.com + friendly_name: Scranton Office + sip_registration: true + sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + credential_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialListMappings.json + ip_access_control_list_mappings: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + voice_fallback_method: POST + voice_fallback_url: null + voice_method: POST + voice_status_callback_method: POST + voice_status_callback_url: null + voice_url: https://dundermifflin.example.com/twilio/app.php + emergency_calling_enabled: true + secure: true + byoc_trunk_sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + emergency_caller_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSipDomain - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22641,6 +28439,22 @@ paths: description: Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. + examples: + update: + value: + DomainName: dunder-mifflin-scranton.sip.twilio.com + FriendlyName: Scranton Office + VoiceFallbackMethod: POST + VoiceFallbackUrl: '' + VoiceMethod: POST + VoiceStatusCallbackMethod: POST + VoiceStatusCallbackUrl: '' + VoiceUrl: https://dundermifflin.example.com/twilio/app.php + SipRegistration: true + EmergencyCallingEnabled: true + Secure: true + ByocTrunkSid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EmergencyCallerSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Delete an instance of a Domain parameters: @@ -22670,8 +28484,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipDomain - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json: servers: - url: https://api.twilio.com @@ -22680,10 +28492,10 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: ip_address: '{account_sid: account_sid, ip_access_control_list_sid: sid}' parent: /Accounts/{AccountSid}/SIP.json + pathType: list get: description: Retrieve a list of IpAccessControlLists that belong to the account used to make the request @@ -22722,41 +28534,73 @@ paths: content: application/json: schema: - type: object - title: ListSipIpAccessControlListResponse - properties: - ip_access_control_lists: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipIpAccessControlListResponse + properties: + ip_access_control_lists: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 + ip_access_control_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 + ip_access_control_lists: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipIpAccessControlList - x-maturity: - - GA post: description: Create a new IpAccessControlList resource parameters: @@ -22776,12 +28620,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipIpAccessControlList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22795,6 +28648,10 @@ paths: IpAccessControlList, up to 255 characters long. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json: servers: - url: https://api.twilio.com @@ -22803,10 +28660,10 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: ip_address: '{account_sid: account_sid, ip_access_control_list_sid: sid}' parent: /Accounts/{AccountSid}/SIP.json + pathType: instance get: description: Fetch a specific instance of an IpAccessControlList parameters: @@ -22836,12 +28693,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipIpAccessControlList - x-maturity: - - GA post: description: Rename an IpAccessControlList parameters: @@ -22871,12 +28737,21 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subresource_uris: + ip_addresses: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSipIpAccessControlList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -22890,6 +28765,10 @@ paths: long. required: - FriendlyName + examples: + update: + value: + FriendlyName: friendly_name delete: description: Delete an IpAccessControlList from the requested account parameters: @@ -22919,8 +28798,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipIpAccessControlList - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json: servers: - url: https://api.twilio.com @@ -22929,8 +28806,8 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: instance get: description: Fetch an IpAccessControlListMapping resource. parameters: @@ -22968,12 +28845,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipIpAccessControlListMapping - x-maturity: - - GA delete: description: Delete an IpAccessControlListMapping resource. parameters: @@ -23011,8 +28896,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json: servers: - url: https://api.twilio.com @@ -23021,8 +28904,8 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/Domains/{Sid}.json + pathType: list post: description: Create a new IpAccessControlListMapping resource. parameters: @@ -23050,12 +28933,20 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipIpAccessControlListMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -23072,6 +28963,10 @@ paths: to the SIP domain. required: - IpAccessControlListSid + examples: + create: + value: + IpAccessControlListSid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of IpAccessControlListMapping resources. parameters: @@ -23117,41 +29012,72 @@ paths: content: application/json: schema: - type: object - title: ListSipIpAccessControlListMappingResponse - properties: - ip_access_control_list_mappings: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipIpAccessControlListMappingResponse + properties: + ip_access_control_list_mappings: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 + ip_access_control_list_mappings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Fri, 17 Jul 2015 21:25:15 +0000 + date_updated: Fri, 17 Jul 2015 21:25:15 +0000 + friendly_name: aaaa + domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 + ip_access_control_list_mappings: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipIpAccessControlListMapping - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json: servers: - url: https://api.twilio.com @@ -23161,8 +29087,8 @@ paths: - sid - ip_address - friendly_name - pathType: list parent: /Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json + pathType: list get: description: Read multiple IpAddress resources. parameters: @@ -23210,41 +29136,74 @@ paths: content: application/json: schema: - type: object - title: ListSipIpAddressResponse - properties: - ip_addresses: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListSipIpAddressResponse + properties: + ip_addresses: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 + ip_addresses: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 + ip_addresses: [] + next_page_uri: null + page: 0 + page_size: 50 + previous_page_uri: null + start: 0 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSipIpAddress - x-maturity: - - GA post: description: Create a new IpAddress resource. parameters: @@ -23274,12 +29233,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSipIpAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -23304,6 +29273,12 @@ paths: required: - FriendlyName - IpAddress + examples: + create: + value: + FriendlyName: friendly_name + IpAddress: 192.168.1.1 + CidrPrefixLength: 32 /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json: servers: - url: https://api.twilio.com @@ -23313,8 +29288,8 @@ paths: - sid - ip_address - friendly_name - pathType: instance parent: /Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json + pathType: instance get: description: Read one IpAddress resource. parameters: @@ -23354,12 +29329,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchSipIpAddress - x-maturity: - - GA post: description: Update an IpAddress resource. parameters: @@ -23399,12 +29384,22 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Mon, 20 Jul 2015 17:27:10 +0000 + date_updated: Mon, 20 Jul 2015 17:27:10 +0000 + friendly_name: friendly_name + ip_access_control_list_sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 + cidr_prefix_length: 32 + sid: IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSipIpAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -23426,6 +29421,12 @@ paths: description: An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. + examples: + update: + value: + FriendlyName: friendly_name + IpAddress: 192.168.1.1 + CidrPrefixLength: 32 delete: description: Delete an IpAddress resource. parameters: @@ -23465,8 +29466,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSipIpAddress - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json: servers: - url: https://api.twilio.com @@ -23475,8 +29474,8 @@ paths: defaultOutputProperties: - call_sid - name - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a Siprec parameters: @@ -23506,12 +29505,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.siprec' + examples: + createNoArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: myName + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateSiprec - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24142,6 +30158,22 @@ paths: Parameter99.Value: type: string description: Parameter value + examples: + createNoArgs: + value: {} + createWithArgs: + value: + Name: myName + ConnectorName: myConnectorName + Track: inbound_track + StatusCallback: http://statuscallback.com + StatusCallbackMethod: PUT + Parameter1.Name: name1 + Parameter1.Value: value1 + Parameter2.Name: name2 + Parameter2.Value: value2 + Parameter3.Name: name3 + Parameter3.Value: value3 /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec/{Sid}.json: servers: - url: https://api.twilio.com @@ -24150,8 +30182,8 @@ paths: defaultOutputProperties: - call_sid - name - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: Stop a Siprec using either the SID of the Siprec resource or the `name` used when creating the resource @@ -24189,12 +30221,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.siprec' + examples: + updateBySid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + updateByName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: mySiprec + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec/SRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateSiprec - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24208,6 +30257,13 @@ paths: description: The status. Must have the value `stopped` required: - Status + examples: + updateBySid: + value: + Status: stopped + updateByName: + value: + Status: stopped /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams.json: servers: - url: https://api.twilio.com @@ -24217,8 +30273,8 @@ paths: defaultOutputProperties: - call_sid - name - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a Stream parameters: @@ -24248,12 +30304,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.stream' + examples: + createNoArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + createWithArgs: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: myName + status: in-progress + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24887,6 +30960,23 @@ paths: description: Parameter value required: - Url + examples: + createNoArgs: + value: + Url: myUrl + createWithArgs: + value: + Name: myName + Url: myUrl + Track: inbound_track + StatusCallback: http://statuscallback.com + StatusCallbackMethod: PUT + Parameter1.Name: name1 + Parameter1.Value: value1 + Parameter2.Name: name2 + Parameter2.Value: value2 + Parameter3.Name: name3 + Parameter3.Value: value3 /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json: servers: - url: https://api.twilio.com @@ -24896,8 +30986,8 @@ paths: defaultOutputProperties: - call_sid - name - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance post: description: Stop a Stream using either the SID of the Stream resource or the `name` used when creating the resource @@ -24935,12 +31025,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.stream' + examples: + updateBySid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: null + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + updateByName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: myStream + status: stopped + date_updated: Thu, 30 Jul 2015 20:00:00 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/MZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: UpdateStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -24954,6 +31061,13 @@ paths: description: The status. Must have the value `stopped` required: - Status + examples: + updateBySid: + value: + Status: stopped + updateByName: + value: + Status: stopped /2010-04-01/Accounts/{AccountSid}/Tokens.json: servers: - url: https://api.twilio.com @@ -24962,8 +31076,8 @@ paths: defaultOutputProperties: - username - ice_servers - pathType: list parent: /Accounts/{Sid}.json + pathType: list post: description: Create a new token for ICE servers parameters: @@ -24983,12 +31097,30 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.token' + examples: + create: + value: + username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + ice_servers: + - urls: stun:global.stun.twilio.com:3478 + - username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + credential: tE2DajzSJwnsSbc123 + urls: turn:global.turn.twilio.com:3478?transport=udp + - username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + credential: tE2DajzSJwnsSbc123 + urls: turn:global.turn.twilio.com:3478?transport=tcp + - username: dc2d2894d5a9023620c467b0e71cfa6a35457e6679785ed6ae9856fe5bdfa269 + credential: tE2DajzSJwnsSbc123 + urls: turn:global.turn.twilio.com:443?transport=tcp + date_updated: Fri, 01 May 2020 01:42:57 +0000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ttl: '86400' + date_created: Fri, 01 May 2020 01:42:57 +0000 + password: tE2DajzSJwnsSbc123 description: Created security: - accountSid_authToken: [] operationId: CreateToken - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -25000,6 +31132,10 @@ paths: type: integer description: The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours). + examples: + create: + value: + Ttl: 1 /2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -25010,8 +31146,8 @@ paths: - type - status - duration - pathType: instance parent: /Accounts/{Sid}.json + pathType: instance get: description: Fetch an instance of a Transcription parameters: @@ -25041,12 +31177,26 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.transcription' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Sun, 13 Feb 2011 02:12:08 +0000 + date_updated: Sun, 13 Feb 2011 02:30:01 +0000 + duration: '1' + price: '-0.05000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + transcription_text: (blank) + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchTranscription - x-maturity: - - GA delete: description: Delete a transcription from the account used to make the request parameters: @@ -25076,8 +31226,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Transcriptions.json: servers: - url: https://api.twilio.com @@ -25088,8 +31236,8 @@ paths: - type - status - duration - pathType: list parent: /Accounts/{Sid}.json + pathType: list get: description: Retrieve a list of transcriptions belonging to the account used to make the request @@ -25128,49 +31276,92 @@ paths: content: application/json: schema: - type: object - title: ListTranscriptionResponse - properties: - transcriptions: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.transcription' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListTranscriptionResponse + properties: + transcriptions: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.transcription' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3 + next_page_uri: null + num_pages: 4 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 4 + transcriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2008-08-01' + date_created: Thu, 25 Aug 2011 20:59:45 +0000 + date_updated: Thu, 25 Aug 2011 20:59:45 +0000 + duration: '10' + price: '0.00000' + price_unit: USD + recording_sid: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + transcription_text: null + type: fast + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/TRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=3 + next_page_uri: null + num_pages: 4 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 4 + transcriptions: [] + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json?PageSize=1&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTranscription - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage.json: servers: - url: https://api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Accounts/{Sid}.json + pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records.json: servers: - url: https://api.twilio.com @@ -25182,8 +31373,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage.json + pathType: list get: description: Retrieve a list of usage-records belonging to the account used to make the request @@ -25206,6 +31397,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_record_enum_category' + examples: + readFull: + value: calleridlookups + readEmpty: + value: calleridlookups - name: StartDate in: query description: 'Only include usage that has occurred on or after this date. @@ -25215,6 +31411,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: EndDate in: query description: 'Only include usage that occurred on or before this date. Specify @@ -25224,6 +31425,11 @@ paths: schema: type: string format: date + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: IncludeSubaccounts in: query description: 'Whether to include usage from the master account and all its @@ -25256,41 +31462,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: totalprice + count: null + count_unit: '' + description: Total Price + end_date: '2015-09-04' + price: '2192.84855' + price_unit: usd + start_date: '2011-08-23' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=totalprice + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=totalprice + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=totalprice + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=totalprice + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=totalprice + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=totalprice + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=totalprice + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=totalprice + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice&StartDate=2011-08-23&EndDate=2015-09-04 + usage: '2192.84855' + usage_unit: usd + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json: servers: - url: https://api.twilio.com @@ -25302,8 +31561,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -25375,41 +31634,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordAllTimeResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordAllTimeResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2011-08-23' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Category=sms-inbound-shortcode&StartDate=2011-08-23&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordAllTime - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json: servers: - url: https://api.twilio.com @@ -25421,8 +31733,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -25494,41 +31806,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordDailyResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordDailyResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1 + next_page_uri: null + num_pages: 101844 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 101844 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-06' + price: '0' + price_unit: usd + start_date: '2015-09-06' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Category=sms-inbound-shortcode&StartDate=2015-09-06&EndDate=2015-09-06 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily?Page=101843&PageSize=1 + next_page_uri: null + num_pages: 101844 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 101844 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordDaily - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json: servers: - url: https://api.twilio.com @@ -25540,8 +31905,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -25613,41 +31978,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordLastMonthResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordLastMonthResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-08-31' + price: '0' + price_unit: usd + start_date: '2015-08-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Category=sms-inbound-shortcode&StartDate=2015-08-01&EndDate=2015-08-31 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordLastMonth - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json: servers: - url: https://api.twilio.com @@ -25659,8 +32077,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -25732,41 +32150,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordMonthlyResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordMonthlyResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1 + next_page_uri: null + num_pages: 3450 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 3450 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-09-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly?Page=3449&PageSize=1 + next_page_uri: null + num_pages: 3450 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 3450 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordMonthly - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json: servers: - url: https://api.twilio.com @@ -25778,8 +32249,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -25851,41 +32322,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordThisMonthResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordThisMonthResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-09-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Category=sms-inbound-shortcode&StartDate=2015-09-01&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordThisMonth - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json: servers: - url: https://api.twilio.com @@ -25897,8 +32421,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -25970,41 +32494,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordTodayResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordTodayResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-09-04' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Category=sms-inbound-shortcode&StartDate=2015-09-04&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordToday - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json: servers: - url: https://api.twilio.com @@ -26016,8 +32593,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -26089,41 +32666,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordYearlyResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordYearlyResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1 + next_page_uri: null + num_pages: 345 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 345 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-04' + price: '0' + price_unit: usd + start_date: '2015-01-01' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Category=sms-inbound-shortcode&StartDate=2015-01-01&EndDate=2015-09-04 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly?Page=344&PageSize=1 + next_page_uri: null + num_pages: 345 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 345 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordYearly - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json: servers: - url: https://api.twilio.com @@ -26135,8 +32765,8 @@ paths: - end_date - count - count_unit - pathType: list parent: /Accounts/{AccountSid}/Usage/Records.json + pathType: list get: description: '' parameters: @@ -26208,41 +32838,94 @@ paths: content: application/json: schema: - type: object - title: ListUsageRecordYesterdayResponse - properties: - usage_records: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageRecordYesterdayResponse + properties: + usage_records: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + as_of: '2019-06-24T22:32:49+00:00' + category: sms-inbound-shortcode + count: '0' + count_unit: messages + description: Short Code Inbound SMS + end_date: '2015-09-03' + price: '0' + price_unit: usd + start_date: '2015-09-03' + subresource_uris: + all_time: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/AllTime.json?Category=sms-inbound-shortcode + daily: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Daily.json?Category=sms-inbound-shortcode + last_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/LastMonth.json?Category=sms-inbound-shortcode + monthly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Monthly.json?Category=sms-inbound-shortcode + this_month: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/ThisMonth.json?Category=sms-inbound-shortcode + today: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Today.json?Category=sms-inbound-shortcode + yearly: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yearly.json?Category=sms-inbound-shortcode + yesterday: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday.json?Category=sms-inbound-shortcode + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Category=sms-inbound-shortcode&StartDate=2015-09-03&EndDate=2015-09-03 + usage: '0' + usage_unit: messages + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=0&PageSize=1 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday?Page=68&PageSize=1 + next_page_uri: null + num_pages: 69 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 69 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records/Yesterday + usage_records: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageRecordYesterday - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json: servers: - url: https://api.twilio.com @@ -26253,8 +32936,8 @@ paths: - friendly_name - usage_category - trigger_by - pathType: instance parent: /Accounts/{AccountSid}/Usage.json + pathType: instance get: description: Fetch and instance of a usage-trigger parameters: @@ -26284,12 +32967,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice description: OK security: - accountSid_authToken: [] operationId: FetchUsageTrigger - x-maturity: - - GA post: description: Update an instance of a usage trigger parameters: @@ -26319,12 +33019,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice description: OK security: - accountSid_authToken: [] operationId: UpdateUsageTrigger - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26353,6 +33070,12 @@ paths: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. + examples: + update: + value: + CallbackMethod: GET + CallbackUrl: https://example.com + FriendlyName: friendly_name delete: description: '' parameters: @@ -26382,8 +33105,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUsageTrigger - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json: servers: - url: https://api.twilio.com @@ -26394,8 +33115,8 @@ paths: - friendly_name - usage_category - trigger_by - pathType: list parent: /Accounts/{AccountSid}/Usage.json + pathType: list post: description: Create a new UsageTrigger parameters: @@ -26415,12 +33136,29 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice description: Created security: - accountSid_authToken: [] operationId: CreateUsageTrigger - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26479,6 +33217,16 @@ paths: - CallbackUrl - TriggerValue - UsageCategory + examples: + create: + value: + CallbackMethod: GET + CallbackUrl: https://example.com + FriendlyName: friendly_name + Recurring: daily + TriggerBy: count + TriggerValue: trigger_value + UsageCategory: calleridlookups get: description: Retrieve a list of usage-triggers belonging to the account used to make the request @@ -26501,6 +33249,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_trigger_enum_recurring' + examples: + readFull: + value: daily + readEmpty: + value: daily - name: TriggerBy in: query description: 'The trigger field of the UsageTriggers to read. Can be: `count`, @@ -26508,6 +33261,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_trigger_enum_trigger_field' + examples: + readFull: + value: count + readEmpty: + value: count - name: UsageCategory in: query description: The usage category of the UsageTriggers to read. Must be a supported @@ -26515,6 +33273,11 @@ paths: schema: type: string $ref: '#/components/schemas/usage_trigger_enum_usage_category' + examples: + readFull: + value: calleridlookups + readEmpty: + value: calleridlookups - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -26539,41 +33302,87 @@ paths: content: application/json: schema: - type: object - title: ListUsageTriggerResponse - properties: - usage_triggers: - type: array - items: - $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' - end: - type: integer - first_page_uri: - type: string - format: uri - next_page_uri: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_uri: - type: string - format: uri - nullable: true - start: - type: integer - uri: - type: string - format: uri + allOf: + - properties: + end: + type: integer + first_page_uri: + format: uri + type: string + next_page_uri: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_uri: + format: uri + nullable: true + type: string + start: + type: integer + uri: + format: uri + type: string + type: object + - type: object + title: ListUsageTriggerResponse + properties: + usage_triggers: + type: array + items: + $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + examples: + readFull: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626 + next_page_uri: null + num_pages: 627 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 627 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers + usage_triggers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + api_version: '2010-04-01' + callback_method: GET + callback_url: http://cap.com/streetfight + current_value: '0' + date_created: Sun, 06 Sep 2015 12:58:45 +0000 + date_fired: null + date_updated: Sun, 06 Sep 2015 12:58:45 +0000 + friendly_name: raphael-cluster-1441544325.86 + recurring: yearly + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trigger_by: price + trigger_value: '50' + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_category: totalprice + usage_record_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Records?Category=totalprice + readEmpty: + value: + end: 0 + first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=0 + last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers?PageSize=1&Page=626 + next_page_uri: null + num_pages: 627 + page: 0 + page_size: 1 + previous_page_uri: null + start: 0 + total: 627 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage/Triggers + usage_triggers: [] description: OK security: - accountSid_authToken: [] operationId: ListUsageTrigger - x-maturity: - - GA /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json: servers: - url: https://api.twilio.com @@ -26582,8 +33391,8 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Create a new User Defined Message for the given Call SID. parameters: @@ -26613,12 +33422,17 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.user_defined_message' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: KXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 description: Created security: - accountSid_authToken: [] operationId: CreateUserDefinedMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26636,6 +33450,11 @@ paths: be a unique string value per API call and can be a randomly generated. required: - Content + examples: + create: + value: + Content: '{"key":"value"}' + IdempotencyKey: '1' /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions.json: servers: - url: https://api.twilio.com @@ -26644,8 +33463,8 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: list post: description: Subscribe to User Defined Messages for a given Call SID. parameters: @@ -26676,12 +33495,18 @@ paths: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.user_defined_message_subscription' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: Wed, 18 Dec 2019 20:02:01 +0000 + uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions/ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreateUserDefinedMessageSubscription - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -26713,6 +33538,12 @@ paths: above `Url`. Either `GET` or `POST`. Default is `POST`. required: - Callback + examples: + create: + value: + Callback: http://www.example.com + Method: POST + IdempotencyKey: '1' /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions/{Sid}.json: servers: - url: https://api.twilio.com @@ -26721,8 +33552,8 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /Accounts/{AccountSid}/Calls/{Sid}.json + pathType: instance delete: description: Delete a specific User Defined Message Subscription. parameters: @@ -26762,17 +33593,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserDefinedMessageSubscription - x-maturity: - - GA servers: - url: https://api.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml index ab81d42f..bcb45a83 100644 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: autopilot.v1.assistant: type: object @@ -869,10 +873,6 @@ components: type: string nullable: true description: The method used when calling the webhook's URL. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Autopilot description: This is the public Twilio REST API. @@ -884,19 +884,18 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Assistants/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: field_type: '{assistant_sid: sid}' task: '{assistant_sid: sid}' @@ -906,6 +905,7 @@ paths: defaults: '{assistant_sid: sid}' dialogue: '{assistant_sid: sid}' webhook: '{assistant_sid: sid}' + pathType: instance get: description: '' parameters: @@ -922,12 +922,35 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + development_stage: in-development + needs_model_build: false + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults + dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed description: OK security: - accountSid_authToken: [] operationId: FetchAssistant - x-maturity: - - Preview post: description: '' parameters: @@ -944,12 +967,35 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + development_stage: in-development + needs_model_build: false + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults + dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed description: OK security: - accountSid_authToken: [] operationId: UpdateAssistant - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -991,6 +1037,17 @@ paths: DevelopmentStage: type: string description: A string describing the state of the assistant. + examples: + update: + value: + FriendlyName: so so friendly + UniqueName: so-so-unique + LogQueries: true + DevelopmentStage: in-development + CallbackUrl: https://example.com/callback_url + CallbackEvents: model_build_completed model_build_failed + StyleSheet: '{}' + Defaults: '{}' delete: description: '' parameters: @@ -1007,18 +1064,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAssistant - x-maturity: - - Preview /v1/Assistants: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: field_type: '{assistant_sid: sid}' task: '{assistant_sid: sid}' @@ -1028,6 +1082,7 @@ paths: defaults: '{assistant_sid: sid}' dialogue: '{assistant_sid: sid}' webhook: '{assistant_sid: sid}' + pathType: list get: description: '' parameters: @@ -1063,34 +1118,77 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + assistants: [] + meta: + first_page_url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 + key: assistants + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 + readFull: + value: + assistants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + development_stage: in-development + needs_model_build: false + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults + dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed + meta: + first_page_url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 + key: assistants + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAssistant - x-maturity: - - Preview post: description: '' responses: @@ -1099,12 +1197,35 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + development_stage: in-development + needs_model_build: false + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults + dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed description: Created security: - accountSid_authToken: [] operationId: CreateAssistant - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1144,16 +1265,26 @@ paths: tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks. + examples: + create: + value: + FriendlyName: so so friendly + UniqueName: so-so-unique + LogQueries: true + CallbackUrl: https://example.com/callback_url + CallbackEvents: model_build_completed model_build_failed + StyleSheet: '{}' + Defaults: '{}' /v1/Assistants/{AssistantSid}/Defaults: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - data - pathType: instance parent: /Assistants/{Sid} className: defaults + pathType: instance get: description: '' parameters: @@ -1170,12 +1301,17 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.defaults' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults description: OK security: - accountSid_authToken: [] operationId: FetchDefaults - x-maturity: - - Preview post: description: '' parameters: @@ -1192,12 +1328,17 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.defaults' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults + data: {} description: OK security: - accountSid_authToken: [] operationId: UpdateDefaults - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1208,16 +1349,20 @@ paths: Defaults: description: A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations. + examples: + update: + value: + Defaults: '{}' /v1/Assistants/{AssistantSid}/Dialogues/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - data - pathType: instance parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -1241,33 +1386,39 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.dialogue' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} description: OK security: - accountSid_authToken: [] operationId: FetchDialogue - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Dialogues: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - data - pathType: list parent: /Assistants/{Sid} + pathType: list /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - field_type - pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} + pathType: instance get: description: '' parameters: @@ -1298,12 +1449,22 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.field' + examples: + fetch: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type: field_type description: OK security: - accountSid_authToken: [] operationId: FetchField - x-maturity: - - Preview delete: description: '' parameters: @@ -1334,19 +1495,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteField - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - field_type - pathType: list parent: /Assistants/{AssistantSid}/Tasks/{Sid} + pathType: list get: description: '' parameters: @@ -1396,34 +1555,64 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.task.field' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + fields: [] + meta: + page: 0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + key: fields + next_page_url: null + previous_page_url: null + page_size: 50 + readFull: + value: + fields: + - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type: field_type + meta: + page: 0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + key: fields + next_page_url: null + previous_page_url: null + page_size: 50 description: OK security: - accountSid_authToken: [] operationId: ListField - x-maturity: - - Preview post: description: '' parameters: @@ -1447,12 +1636,22 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.field' + examples: + create: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type: field_type description: Created security: - accountSid_authToken: [] operationId: CreateField - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1474,19 +1673,24 @@ paths: required: - FieldType - UniqueName + examples: + create: + value: + UniqueName: unique_name + FieldType: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Assistants/{AssistantSid}/FieldTypes/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -1510,12 +1714,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + examples: + fetch: + value: + unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchFieldType - x-maturity: - - Preview post: description: '' parameters: @@ -1539,12 +1754,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + examples: + update: + value: + unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateFieldType - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1562,6 +1788,11 @@ paths: the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique. + examples: + update: + value: + UniqueName: unique_name + FriendlyName: friendly_name delete: description: '' parameters: @@ -1585,21 +1816,19 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFieldType - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/FieldTypes: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: @@ -1642,34 +1871,65 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + previous_page_url: null + page: 0 + page_size: 50 + next_page_url: null + key: field_types + field_types: [] + readFull: + value: + meta: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + previous_page_url: null + page: 0 + page_size: 50 + next_page_url: null + key: field_types + field_types: + - unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListFieldType - x-maturity: - - Preview post: description: '' parameters: @@ -1686,12 +1946,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + examples: + create: + value: + unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateFieldType - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1712,17 +1983,22 @@ paths: long. required: - UniqueName + examples: + create: + value: + UniqueName: unique_name + FriendlyName: friendly_name /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - value - language - pathType: instance parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} + pathType: instance get: description: '' parameters: @@ -1753,12 +2029,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + language: language + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + value: value + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + synonym_of: null description: OK security: - accountSid_authToken: [] operationId: FetchFieldValue - x-maturity: - - Preview delete: description: '' parameters: @@ -1789,19 +2076,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFieldValue - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - value - language - pathType: list parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} + pathType: list get: description: '' parameters: @@ -1826,6 +2111,11 @@ paths: `en-US`' schema: type: string + examples: + readEmpty: + value: language + readFull: + value: language - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1858,34 +2148,65 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + field_values: [] + meta: + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + page_size: 50 + previous_page_url: null + key: field_values + page: 0 + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + readFull: + value: + field_values: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + language: language + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + value: value + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + meta: + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + page_size: 50 + previous_page_url: null + key: field_values + page: 0 + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListFieldValue - x-maturity: - - Preview post: description: '' parameters: @@ -1908,12 +2229,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + language: language + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + value: value + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb description: Created security: - accountSid_authToken: [] operationId: CreateFieldValue - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1936,18 +2268,24 @@ paths: required: - Language - Value + examples: + create: + value: + Value: value + Language: language + SynonymOf: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb /v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - status - date_created - pathType: instance parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -1971,12 +2309,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: enqueued + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: null + error_code: null description: OK security: - accountSid_authToken: [] operationId: FetchModelBuild - x-maturity: - - Preview post: description: '' parameters: @@ -2000,12 +2349,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: 100 + error_code: null description: OK security: - accountSid_authToken: [] operationId: UpdateModelBuild - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2019,6 +2379,10 @@ paths: the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource. + examples: + update: + value: + UniqueName: unique_name delete: description: '' parameters: @@ -2042,20 +2406,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteModelBuild - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/ModelBuilds: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - status - date_created - pathType: list parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: @@ -2098,34 +2460,65 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + key: model_builds + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + page_size: 50 + model_builds: [] + readFull: + value: + meta: + page: 0 + key: model_builds + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + page_size: 50 + model_builds: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: null + error_code: 23001 description: OK security: - accountSid_authToken: [] operationId: ListModelBuild - x-maturity: - - Preview post: description: '' parameters: @@ -2142,12 +2535,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: enqueued + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: null + error_code: null description: Created security: - accountSid_authToken: [] operationId: CreateModelBuild - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2166,18 +2570,23 @@ paths: the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource. + examples: + create: + value: + UniqueName: unique_name + StatusCallback: http://www.example.com /v1/Assistants/{AssistantSid}/Queries/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - query - status - language - pathType: instance parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -2201,12 +2610,32 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.query' + examples: + fetch: + value: + language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: name + fields: + - name: name + value: value + type: type + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: voice + dialogue_sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchQuery - x-maturity: - - Preview post: description: '' parameters: @@ -2230,12 +2659,32 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.query' + examples: + update: + value: + language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: name + fields: + - name: name + value: value + type: type + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: sms + dialogue_sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateQuery - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2254,6 +2703,11 @@ paths: type: string description: 'The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded`' + examples: + update: + value: + Status: status + SampleSid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' parameters: @@ -2277,20 +2731,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteQuery - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Queries: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - query - status - language - pathType: list parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: @@ -2308,18 +2760,33 @@ paths: For example: `en-US`.' schema: type: string + examples: + readEmpty: + value: language + readFull: + value: language - name: ModelBuild in: query description: The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. schema: type: string + examples: + readEmpty: + value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: 'The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`' schema: type: string + examples: + readEmpty: + value: status + readFull: + value: status - name: DialogueSid in: query description: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). @@ -2328,6 +2795,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^UK[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2360,34 +2832,74 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.query' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + queries: [] + meta: + previous_page_url: null + next_page_url: null + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page: 0 + key: queries + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page_size: 50 + readFull: + value: + queries: + - language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: name + fields: + - name: name + value: value + type: type + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: null + dialogue_sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + previous_page_url: null + next_page_url: null + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page: 0 + key: queries + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page_size: 50 description: OK security: - accountSid_authToken: [] operationId: ListQuery - x-maturity: - - Preview post: description: '' parameters: @@ -2404,12 +2916,32 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.query' + examples: + create: + value: + language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: name + fields: + - name: name + value: value + type: type + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: voice + dialogue_sid: null description: Created security: - accountSid_authToken: [] operationId: CreateQuery - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2440,18 +2972,25 @@ paths: required: - Language - Query + examples: + create: + value: + Language: language + Query: query + Tasks: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + ModelBuild: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Assistants/Restore: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - sid - unique_name - friendly_name - pathType: list mountName: restore_assistant + pathType: list post: description: '' responses: @@ -2460,12 +2999,25 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.restore_assistant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + unique_name: so-so-unique + friendly_name: so so friendly + needs_model_build: false + latest_model_build_sid: null + log_queries: true + development_stage: in-development + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed description: OK security: - accountSid_authToken: [] operationId: UpdateRestoreAssistant - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2479,18 +3031,22 @@ paths: the Assistant resource to restore. required: - Assistant + examples: + update: + value: + Assistant: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - tagged_text - language - source_channel - pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} + pathType: instance get: description: '' parameters: @@ -2524,12 +3080,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + examples: + fetch: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: null description: OK security: - accountSid_authToken: [] operationId: FetchSample - x-maturity: - - Preview post: description: '' parameters: @@ -2563,12 +3130,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + examples: + update: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: alexa description: OK security: - accountSid_authToken: [] operationId: UpdateSample - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2590,6 +3168,11 @@ paths: description: 'The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.' + examples: + update: + value: + Language: language + TaggedText: tagged_text delete: description: '' parameters: @@ -2623,20 +3206,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSample - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - tagged_text - language - source_channel - pathType: list parent: /Assistants/{AssistantSid}/Tasks/{Sid} + pathType: list get: description: '' parameters: @@ -2660,6 +3241,11 @@ paths: string that specifies the language used for the sample. For example: `en-US`.' schema: type: string + examples: + readEmpty: + value: language + readFull: + value: language - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2692,34 +3278,65 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + samples: [] + meta: + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + previous_page_url: null + key: samples + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + page: 0 + page_size: 50 + readFull: + value: + samples: + - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: sms + meta: + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + previous_page_url: null + key: samples + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + page: 0 + page_size: 50 description: OK security: - accountSid_authToken: [] operationId: ListSample - x-maturity: - - Preview post: description: '' parameters: @@ -2743,12 +3360,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + examples: + create: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: alexa description: Created security: - accountSid_authToken: [] operationId: CreateSample - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2773,15 +3401,21 @@ paths: required: - Language - TaggedText + examples: + create: + value: + Language: language + TaggedText: tagged_text + SourceChannel: alexa /v1/Assistants/{AssistantSid}/StyleSheet: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - data - pathType: instance parent: /Assistants/{Sid} + pathType: instance get: description: Returns Style sheet JSON object for the Assistant parameters: @@ -2798,12 +3432,17 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet description: OK security: - accountSid_authToken: [] operationId: FetchStyleSheet - x-maturity: - - Preview post: description: Updates the style sheet for an Assistant identified by `assistant_sid`. parameters: @@ -2820,12 +3459,17 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + data: {} description: OK security: - accountSid_authToken: [] operationId: UpdateStyleSheet - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2835,22 +3479,26 @@ paths: properties: StyleSheet: description: The JSON string that describes the style sheet object. + examples: + update: + value: + StyleSheet: '{}' /v1/Assistants/{AssistantSid}/Tasks/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: field: '{assistant_sid: assistant_sid, task_sid: sid}' sample: '{assistant_sid: assistant_sid, task_sid: sid}' task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -2874,12 +3522,27 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task' + examples: + fetch: + value: + unique_name: unique_name + links: + fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: OK security: - accountSid_authToken: [] operationId: FetchTask - x-maturity: - - Preview post: description: '' parameters: @@ -2903,12 +3566,27 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task' + examples: + update: + value: + unique_name: unique_name + links: + fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: OK security: - accountSid_authToken: [] operationId: UpdateTask - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2933,6 +3611,13 @@ paths: type: string format: uri description: The URL from which the Assistant can fetch actions. + examples: + update: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Actions: '{}' + ActionsUrl: https://example.com/actions_url delete: description: '' parameters: @@ -2956,24 +3641,22 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTask - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Tasks: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: field: '{assistant_sid: assistant_sid, task_sid: sid}' sample: '{assistant_sid: assistant_sid, task_sid: sid}' task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: @@ -3016,34 +3699,69 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.task' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + key: tasks + page_size: 50 + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + page: 0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + previous_page_url: null + tasks: [] + readFull: + value: + meta: + key: tasks + page_size: 50 + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + page: 0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + previous_page_url: null + tasks: + - unique_name: unique_name + links: + fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: OK security: - accountSid_authToken: [] operationId: ListTask - x-maturity: - - Preview post: description: '' parameters: @@ -3060,12 +3778,27 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task' + examples: + create: + value: + unique_name: unique_name + links: + fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: Created security: - accountSid_authToken: [] operationId: CreateTask - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3094,17 +3827,24 @@ paths: description: The URL from which the Assistant can fetch actions. required: - UniqueName + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Actions: '{}' + ActionsUrl: https://example.com/actions_url /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - data - pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} mountName: task_actions className: task_actions + pathType: instance get: description: Returns JSON actions for the Task. parameters: @@ -3129,12 +3869,18 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDdddddddddddddddddddddddddddddddd + data: {} + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions description: OK security: - accountSid_authToken: [] operationId: FetchTaskActions - x-maturity: - - Preview post: description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. parameters: @@ -3159,12 +3905,18 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDdddddddddddddddddddddddddddddddd + data: {} + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions description: OK security: - accountSid_authToken: [] operationId: UpdateTaskActions - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3175,17 +3927,21 @@ paths: Actions: description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task. + examples: + update: + value: + Actions: '{"actions":[{}]}' /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - samples_count - fields_count - pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} className: task_statistics + pathType: instance get: description: '' parameters: @@ -3209,16 +3965,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.task_statistics' + examples: + fetch: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + samples_count: 0 + fields_count: 0 description: OK security: - accountSid_authToken: [] operationId: FetchTaskStatistics - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Webhooks/{Sid}: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3226,8 +3989,8 @@ paths: - events - wehbook_url - webhook_method - pathType: instance parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -3251,12 +4014,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + examples: + fetch: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + unique_name: unique_name + events: ondialogueend + webhook_url: https://example.com/url + webhook_method: POST description: OK security: - accountSid_authToken: [] operationId: FetchWebhook - x-maturity: - - Preview post: description: '' parameters: @@ -3280,12 +4054,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + examples: + update: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + unique_name: unique_name + events: ondialogueend + webhook_url: https://example.com/url + webhook_method: POST description: OK security: - accountSid_authToken: [] operationId: UpdateWebhook - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3310,6 +4095,13 @@ paths: WebhookMethod: type: string description: The method to be used when calling the webhook's URL. + examples: + update: + value: + UniqueName: unique_name + Events: ondialogueend + WebhookUrl: https://example.com/url + WebhookMethod: POST delete: description: '' parameters: @@ -3333,12 +4125,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWebhook - x-maturity: - - Preview /v1/Assistants/{AssistantSid}/Webhooks: servers: - url: https://autopilot.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3346,8 +4136,8 @@ paths: - events - wehbook_url - webhook_method - pathType: list parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: @@ -3390,34 +4180,65 @@ paths: items: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + key: webhooks + page_size: 50 + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + page: 0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + previous_page_url: null + webhooks: [] + readFull: + value: + meta: + key: webhooks + page_size: 50 + next_page_url: null + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + page: 0 + first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + previous_page_url: null + webhooks: + - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + unique_name: unique_name + events: ondialogueend + webhook_url: https://example.com/url + webhook_method: POST description: OK security: - accountSid_authToken: [] operationId: ListWebhook - x-maturity: - - Preview post: description: '' parameters: @@ -3434,12 +4255,23 @@ paths: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + examples: + create: + value: + url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + unique_name: unique_name + events: ondialogueend + webhook_url: https://example.com/url + webhook_method: POST description: Created security: - accountSid_authToken: [] operationId: CreateWebhook - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3468,10 +4300,12 @@ paths: - UniqueName - Events - WebhookUrl + examples: + create: + value: + UniqueName: unique_name + Events: ondialogueend + WebhookUrl: https://example.com/url + WebhookMethod: POST servers: - url: https://autopilot.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 53466cd7..7042d6a8 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: bulkexports.v1.export.day: type: object @@ -231,10 +235,6 @@ components: - Failed - RunningToBeDeleted - DeletedByUserRequest - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Bulkexports description: This is the public Twilio REST API. @@ -246,13 +246,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Exports/{ResourceType}/Days/{Day}: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - friendly_name @@ -261,8 +261,8 @@ paths: - resource_type - size - redirectTo - pathType: instance parent: /Exports/{ResourceType} + pathType: instance get: description: Fetch a specific Day. parameters: @@ -286,16 +286,18 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.day-instance' + examples: + fetch: + value: + redirect_to: https://documentation-example-twilio-bucket.s3.amazonaws.com/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Temporary Redirect security: - accountSid_authToken: [] operationId: FetchDay - x-maturity: - - GA /v1/Exports/{ResourceType}/Days: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - friendly_name @@ -304,8 +306,8 @@ paths: - resource_type - size - redirectTo - pathType: list parent: /Exports/{ResourceType} + pathType: list get: description: Retrieve a list of all Days for a resource. parameters: @@ -348,44 +350,70 @@ paths: items: $ref: '#/components/schemas/bulkexports.v1.export.day' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + days: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + next_page_url: null + key: days + readFull: + value: + days: + - day: '2017-04-01' + size: 100 + resource_type: Messages + create_date: '2017-04-02' + friendly_name: friendly_name + meta: + page: 0 + page_size: 50 + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Days?PageSize=50&Page=0 + next_page_url: null + key: days description: OK security: - accountSid_authToken: [] operationId: ListDay - x-maturity: - - GA /v1/Exports/{ResourceType}: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: day: '{resource_type: resource_type}' export_custom_job: '{resource_type: resource_type}' + pathType: instance get: description: Fetch a specific Export. parameters: @@ -402,26 +430,31 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export' + examples: + fetch: + value: + resource_type: Messages + url: https://bulkexports.twilio.com/v1/Exports/Messages + links: + days: https://bulkexports.twilio.com/v1/Exports/Messages/Days description: OK security: - accountSid_authToken: [] operationId: FetchExport - x-maturity: - - GA /v1/Exports: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: day: '{resource_type: resource_type}' export_custom_job: '{resource_type: resource_type}' + pathType: list /v1/Exports/{ResourceType}/Configuration: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - enabled @@ -429,8 +462,8 @@ paths: - url - webhook_method - webhook_url - pathType: instance mountName: export_configuration + pathType: instance get: description: Fetch a specific Export Configuration. parameters: @@ -447,12 +480,18 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export_configuration' + examples: + fetch: + value: + url: https://bulkexports.twilio.com/v1/Exports/Messages/Configuration + enabled: true + webhook_url: '' + webhook_method: '' + resource_type: Messages description: OK security: - accountSid_authToken: [] operationId: FetchExportConfiguration - x-maturity: - - GA post: description: Update a specific Export Configuration. parameters: @@ -469,12 +508,18 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export_configuration' + examples: + update: + value: + url: https://bulkexports.twilio.com/v1/Exports/Messages/Configuration + enabled: true + webhook_url: '' + resource_type: Messages + webhook_method: '' description: OK security: - accountSid_authToken: [] operationId: UpdateExportConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -496,10 +541,14 @@ paths: 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 + examples: + update: + value: + Enabled: true /v1/Exports/{ResourceType}/Jobs: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - details @@ -513,9 +562,9 @@ paths: - start_day - webhook_method - webhook_url - pathType: list parent: /Exports/{ResourceType} mountName: export_custom_jobs + pathType: list get: description: '' parameters: @@ -558,34 +607,66 @@ paths: items: $ref: '#/components/schemas/bulkexports.v1.export.export_custom_job' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + page_size: 50 + key: jobs + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + next_page_url: null + page: 0 + jobs: [] + readFull: + value: + meta: + previous_page_url: null + url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + page_size: 50 + key: jobs + first_page_url: https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0 + next_page_url: null + page: 0 + jobs: + - start_day: start_day + job_sid: JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + webhook_method: webhook_method + details: {} + end_day: end_day + webhook_url: webhook_url + email: email + resource_type: resource_type + job_queue_position: '1' + estimated_completion_time: '2021-03-15T20:20:14.547' description: OK security: - accountSid_authToken: [] operationId: ListExportCustomJob - x-maturity: - - GA post: description: '' parameters: @@ -602,12 +683,24 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.export_custom_job' + examples: + create: + value: + start_day: start_day + job_sid: JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + webhook_method: webhook_method + details: {} + end_day: end_day + webhook_url: webhook_url + email: email + resource_type: resource_type + job_queue_position: '1' + estimated_completion_time: '2021-03-15T20:20:14.547' description: Created security: - accountSid_authToken: [] operationId: CreateExportCustomJob - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -647,10 +740,19 @@ paths: - StartDay - EndDay - FriendlyName + examples: + create: + value: + EndDay: end_day_value + StartDay: start_day_value + WebhookUrl: webhook_url_value + WebhookMethod: webhook_method_value + FriendlyName: friendly_name_value + Email: email_value /v1/Exports/Jobs/{JobSid}: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - details @@ -664,8 +766,8 @@ paths: - start_day - webhook_method - webhook_url - pathType: instance parent: /Exports + pathType: instance get: description: '' parameters: @@ -685,12 +787,25 @@ paths: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.job' + examples: + fetch: + value: + start_day: start_day + job_sid: JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://bulkexports.twilio.com/v1/Exports/Jobs/JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + end_day: end_day + details: {} + webhook_url: https://webhookexample.com + webhook_method: webhook_method + email: email + resource_type: resource_type + job_queue_position: '1' + estimated_completion_time: '2021-03-15T20:20:14.547' description: OK security: - accountSid_authToken: [] operationId: FetchJob - x-maturity: - - GA delete: description: '' parameters: @@ -710,12 +825,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteJob - x-maturity: - - GA /v1/Exports/Jobs: servers: - url: https://bulkexports.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - details @@ -729,10 +842,7 @@ paths: - start_day - webhook_method - webhook_url - pathType: list parent: /Exports + pathType: list servers: - url: https://bulkexports.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index 774e811b..10afce97 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: chat.v1.service.channel: type: object @@ -756,10 +760,6 @@ components: - joined - invited - not_participating - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Chat description: This is the public Twilio REST API. @@ -771,7 +771,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: @@ -783,12 +783,12 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -815,12 +815,31 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' parameters: @@ -847,8 +866,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' parameters: @@ -875,12 +892,31 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -902,6 +938,13 @@ paths: type: string description: A valid JSON string that contains application-specific data. + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' /v1/Services/{ServiceSid}/Channels: servers: - url: https://chat.twilio.com @@ -911,12 +954,12 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -936,12 +979,31 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -968,6 +1030,13 @@ paths: $ref: '#/components/schemas/channel_enum_channel_type' description: 'The visibility of the channel. Can be: `public` or `private` and defaults to `public`.' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' get: description: '' parameters: @@ -1022,34 +1091,73 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v1/Credentials: servers: - url: https://chat.twilio.com @@ -1095,34 +1203,63 @@ paths: items: $ref: '#/components/schemas/chat.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' responses: @@ -1131,12 +1268,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1184,6 +1330,10 @@ paths: the Firebase console, found under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn /v1/Credentials/{Sid}: servers: - url: https://chat.twilio.com @@ -1213,12 +1363,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' parameters: @@ -1238,12 +1397,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1284,6 +1452,10 @@ paths: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' parameters: @@ -1303,8 +1475,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://chat.twilio.com @@ -1314,8 +1484,8 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1352,12 +1522,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' parameters: @@ -1394,8 +1575,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://chat.twilio.com @@ -1405,8 +1584,8 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -1433,12 +1612,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1462,6 +1652,11 @@ paths: assigned to the new member. required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -1491,6 +1686,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1523,34 +1725,65 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://chat.twilio.com @@ -1560,8 +1793,8 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1599,12 +1832,24 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' parameters: @@ -1641,8 +1886,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' parameters: @@ -1680,12 +1923,37 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 666 + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1706,6 +1974,13 @@ paths: nullable: true 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). + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 666 /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://chat.twilio.com @@ -1715,8 +1990,8 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -1743,12 +2018,24 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1773,6 +2060,10 @@ paths: on the [Service](https://www.twilio.com/docs/chat/api/services). required: - Identity + examples: + create: + value: + Identity: Twilio get: description: '' parameters: @@ -1835,34 +2126,66 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://chat.twilio.com @@ -1873,8 +2196,8 @@ paths: - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1914,12 +2237,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' parameters: @@ -1960,8 +2297,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' parameters: @@ -2001,12 +2336,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{"test": "test"}' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2024,6 +2373,10 @@ paths: type: string description: A valid JSON string that contains application-specific data. + examples: + update: + value: + Body: Hello /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://chat.twilio.com @@ -2034,8 +2387,8 @@ paths: - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -2065,12 +2418,41 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAttributes: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2094,6 +2476,14 @@ paths: data. required: - Body + examples: + create: + value: + Body: Hello + createWithAttributes: + value: + Body: Hello + Attributes: '{"test": "test"}' get: description: '' parameters: @@ -2156,34 +2546,68 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v1/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://chat.twilio.com @@ -2193,8 +2617,8 @@ paths: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -2224,12 +2648,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' parameters: @@ -2259,8 +2697,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' parameters: @@ -2290,12 +2726,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2314,6 +2764,10 @@ paths: the documentation. required: - Permission + examples: + update: + value: + Permission: sendMessage /v1/Services/{ServiceSid}/Roles: servers: - url: https://chat.twilio.com @@ -2323,8 +2777,8 @@ paths: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -2344,12 +2798,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2380,6 +2848,12 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' parameters: @@ -2425,34 +2899,68 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://chat.twilio.com @@ -2462,11 +2970,11 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' + pathType: instance get: description: '' parameters: @@ -2486,12 +2994,40 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' parameters: @@ -2511,8 +3047,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' parameters: @@ -2532,12 +3066,116 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: + on_channel_add: + format: webhooks.on_channel_add.format + method: webhooks.on_channel_add.method + url: webhooks.on_channel_add.url + on_channel_added: + format: webhooks.on_channel_added.format + method: webhooks.on_channel_added.method + url: webhooks.on_channel_added.url + on_channel_destroy: + format: webhooks.on_channel_destroy.format + method: webhooks.on_channel_destroy.method + url: webhooks.on_channel_destroy.url + on_channel_destroyed: + format: webhooks.on_channel_destroyed.format + method: webhooks.on_channel_destroyed.method + url: webhooks.on_channel_destroyed.url + on_channel_update: + format: webhooks.on_channel_update.format + method: webhooks.on_channel_update.method + url: webhooks.on_channel_update.url + on_channel_updated: + format: webhooks.on_channel_updated.format + method: webhooks.on_channel_updated.method + url: webhooks.on_channel_updated.url + on_member_add: + format: webhooks.on_member_add.format + method: webhooks.on_member_add.method + url: webhooks.on_member_add.url + on_member_added: + format: webhooks.on_member_added.format + method: webhooks.on_member_added.method + url: webhooks.on_member_added.url + on_member_remove: + format: webhooks.on_member_remove.format + method: webhooks.on_member_remove.method + url: webhooks.on_member_remove.url + on_member_removed: + format: webhooks.on_member_removed.format + method: webhooks.on_member_removed.method + url: webhooks.on_member_removed.url + on_message_remove: + format: webhooks.on_message_remove.format + method: webhooks.on_message_remove.method + url: webhooks.on_message_remove.url + on_message_removed: + format: webhooks.on_message_removed.format + method: webhooks.on_message_removed.method + url: webhooks.on_message_removed.url + on_message_send: + format: webhooks.on_message_send.format + method: webhooks.on_message_send.method + url: webhooks.on_message_send.url + on_message_sent: + format: webhooks.on_message_sent.format + method: webhooks.on_message_sent.method + url: webhooks.on_message_sent.url + on_message_update: + format: webhooks.on_message_update.format + method: webhooks.on_message_update.method + url: webhooks.on_message_update.url + on_message_updated: + format: webhooks.on_message_updated.format + method: webhooks.on_message_updated.method + url: webhooks.on_message_updated.url description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2927,6 +3565,80 @@ paths: type: integer description: The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000. + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Webhooks.OnChannelAdd.Format: webhooks.on_channel_add.format + Webhooks.OnChannelAdd.Method: webhooks.on_channel_add.method + Webhooks.OnChannelAdd.Url: webhooks.on_channel_add.url + Webhooks.OnChannelAdded.Format: webhooks.on_channel_added.format + Webhooks.OnChannelAdded.Method: webhooks.on_channel_added.method + Webhooks.OnChannelAdded.Url: webhooks.on_channel_added.url + Webhooks.OnChannelDestroy.Format: webhooks.on_channel_destroy.format + Webhooks.OnChannelDestroy.Method: webhooks.on_channel_destroy.method + Webhooks.OnChannelDestroy.Url: webhooks.on_channel_destroy.url + Webhooks.OnChannelDestroyed.Format: webhooks.on_channel_destroyed.format + Webhooks.OnChannelDestroyed.Method: webhooks.on_channel_destroyed.method + Webhooks.OnChannelDestroyed.Url: webhooks.on_channel_destroyed.url + Webhooks.OnChannelUpdate.Format: webhooks.on_channel_update.format + Webhooks.OnChannelUpdate.Method: webhooks.on_channel_update.method + Webhooks.OnChannelUpdate.Url: webhooks.on_channel_update.url + Webhooks.OnChannelUpdated.Format: webhooks.on_channel_updated.format + Webhooks.OnChannelUpdated.Method: webhooks.on_channel_updated.method + Webhooks.OnChannelUpdated.Url: webhooks.on_channel_updated.url + Webhooks.OnMemberAdd.Format: webhooks.on_member_add.format + Webhooks.OnMemberAdd.Method: webhooks.on_member_add.method + Webhooks.OnMemberAdd.Url: webhooks.on_member_add.url + Webhooks.OnMemberAdded.Format: webhooks.on_member_added.format + Webhooks.OnMemberAdded.Method: webhooks.on_member_added.method + Webhooks.OnMemberAdded.Url: webhooks.on_member_added.url + Webhooks.OnMemberRemove.Format: webhooks.on_member_remove.format + Webhooks.OnMemberRemove.Method: webhooks.on_member_remove.method + Webhooks.OnMemberRemove.Url: webhooks.on_member_remove.url + Webhooks.OnMemberRemoved.Format: webhooks.on_member_removed.format + Webhooks.OnMemberRemoved.Method: webhooks.on_member_removed.method + Webhooks.OnMemberRemoved.Url: webhooks.on_member_removed.url + Webhooks.OnMessageRemove.Format: webhooks.on_message_remove.format + Webhooks.OnMessageRemove.Method: webhooks.on_message_remove.method + Webhooks.OnMessageRemove.Url: webhooks.on_message_remove.url + Webhooks.OnMessageRemoved.Format: webhooks.on_message_removed.format + Webhooks.OnMessageRemoved.Method: webhooks.on_message_removed.method + Webhooks.OnMessageRemoved.Url: webhooks.on_message_removed.url + Webhooks.OnMessageSend.Format: webhooks.on_message_send.format + Webhooks.OnMessageSend.Method: webhooks.on_message_send.method + Webhooks.OnMessageSend.Url: webhooks.on_message_send.url + Webhooks.OnMessageSent.Format: webhooks.on_message_sent.format + Webhooks.OnMessageSent.Method: webhooks.on_message_sent.method + Webhooks.OnMessageSent.Url: webhooks.on_message_sent.url + Webhooks.OnMessageUpdate.Format: webhooks.on_message_update.format + Webhooks.OnMessageUpdate.Method: webhooks.on_message_update.method + Webhooks.OnMessageUpdate.Url: webhooks.on_message_update.url + Webhooks.OnMessageUpdated.Format: webhooks.on_message_updated.format + Webhooks.OnMessageUpdated.Method: webhooks.on_message_updated.method + Webhooks.OnMessageUpdated.Url: webhooks.on_message_updated.url /v1/Services: servers: - url: https://chat.twilio.com @@ -2936,11 +3648,11 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' + pathType: list post: description: '' responses: @@ -2949,12 +3661,40 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2968,6 +3708,10 @@ paths: resource. It can be up to 64 characters long. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' parameters: @@ -3003,34 +3747,160 @@ paths: items: $ref: '#/components/schemas/chat.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + user_channels: 250 + channel_members: 100 + actions_per_second: 30 + links: + channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + log_enabled: true + new_message: + enabled: false + template: notifications.new_message.template + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: + on_channel_add: + format: webhooks.on_channel_add.format + method: webhooks.on_channel_add.method + url: webhooks.on_channel_add.url + on_channel_added: + format: webhooks.on_channel_added.format + method: webhooks.on_channel_added.method + url: webhooks.on_channel_added.url + on_channel_destroy: + format: webhooks.on_channel_destroy.format + method: webhooks.on_channel_destroy.method + url: webhooks.on_channel_destroy.url + on_channel_destroyed: + format: webhooks.on_channel_destroyed.format + method: webhooks.on_channel_destroyed.method + url: webhooks.on_channel_destroyed.url + on_channel_update: + format: webhooks.on_channel_update.format + method: webhooks.on_channel_update.method + url: webhooks.on_channel_update.url + on_channel_updated: + format: webhooks.on_channel_updated.format + method: webhooks.on_channel_updated.method + url: webhooks.on_channel_updated.url + on_member_add: + format: webhooks.on_member_add.format + method: webhooks.on_member_add.method + url: webhooks.on_member_add.url + on_member_added: + format: webhooks.on_member_added.format + method: webhooks.on_member_added.method + url: webhooks.on_member_added.url + on_member_remove: + format: webhooks.on_member_remove.format + method: webhooks.on_member_remove.method + url: webhooks.on_member_remove.url + on_member_removed: + format: webhooks.on_member_removed.format + method: webhooks.on_member_removed.method + url: webhooks.on_member_removed.url + on_message_remove: + format: webhooks.on_message_remove.format + method: webhooks.on_message_remove.method + url: webhooks.on_message_remove.url + on_message_removed: + format: webhooks.on_message_removed.format + method: webhooks.on_message_removed.method + url: webhooks.on_message_removed.url + on_message_send: + format: webhooks.on_message_send.format + method: webhooks.on_message_send.method + url: webhooks.on_message_send.url + on_message_sent: + format: webhooks.on_message_sent.format + method: webhooks.on_message_sent.method + url: webhooks.on_message_sent.url + on_message_update: + format: webhooks.on_message_update.format + method: webhooks.on_message_update.method + url: webhooks.on_message_update.url + on_message_updated: + format: webhooks.on_message_updated.format + method: webhooks.on_message_updated.method + url: webhooks.on_message_updated.url description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://chat.twilio.com @@ -3040,10 +3910,10 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -3070,12 +3940,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' parameters: @@ -3102,8 +3988,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' parameters: @@ -3130,12 +4014,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3158,6 +4058,12 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is often used for display purposes. + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v1/Services/{ServiceSid}/Users: servers: - url: https://chat.twilio.com @@ -3167,10 +4073,10 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -3190,12 +4096,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v1.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3227,6 +4149,13 @@ paths: new resource. This value is often used for display purposes. required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' parameters: @@ -3272,45 +4201,81 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://chat.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: List all Channels for a given User. parameters: @@ -3363,36 +4328,64 @@ paths: items: $ref: '#/components/schemas/chat.v1.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + links: + channel: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA servers: - url: https://chat.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index f1878bc1..4b14d456 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: chat.v2.service.binding: type: object @@ -1097,10 +1101,6 @@ components: enum: - 'true' - 'false' - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Chat description: This is the public Twilio REST API. @@ -1112,7 +1112,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: @@ -1124,8 +1124,8 @@ paths: - sid - endpoint - identity - pathType: list parent: /Services/{Sid} + pathType: list get: description: '' parameters: @@ -1190,34 +1190,72 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://chat.twilio.com @@ -1227,8 +1265,8 @@ paths: - sid - endpoint - identity - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -1257,12 +1295,30 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser description: OK security: - accountSid_authToken: [] operationId: FetchBinding - x-maturity: - - GA delete: description: '' parameters: @@ -1291,8 +1347,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://chat.twilio.com @@ -1302,13 +1356,13 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' webhook: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -1335,12 +1389,32 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' parameters: @@ -1373,8 +1447,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' parameters: @@ -1407,12 +1479,32 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1451,6 +1543,16 @@ paths: type: string description: 'The `identity` of the User that created the channel. Default is: `system`.' + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username /v2/Services/{ServiceSid}/Channels: servers: - url: https://chat.twilio.com @@ -1460,13 +1562,13 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' webhook: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -1492,12 +1594,32 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1544,6 +1666,16 @@ paths: type: string description: 'The `identity` of the User that created the channel. Default is: `system`.' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username get: description: '' parameters: @@ -1598,34 +1730,74 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: servers: - url: https://chat.twilio.com @@ -1634,8 +1806,8 @@ paths: defaultOutputProperties: - sid - configuration - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list get: description: '' parameters: @@ -1689,34 +1861,95 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListChannelWebhook - x-maturity: - - GA post: description: '' parameters: @@ -1744,12 +1977,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1802,6 +2051,16 @@ paths: the default is 0. required: - Type + examples: + create: + value: + Type: webhook + Configuration.Url: dummy + Configuration.Method: GET + Configuration.Filters: + - onMessageSent + - onChannelDestroyed + Configuration.RetryCount: 2 /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}: servers: - url: https://chat.twilio.com @@ -1810,8 +2069,8 @@ paths: defaultOutputProperties: - sid - configuration - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1848,12 +2107,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchChannelWebhook - x-maturity: - - GA post: description: '' parameters: @@ -1890,12 +2160,28 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1941,6 +2227,15 @@ paths: description: The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0. + examples: + update: + value: + Configuration.Url: dummy + Configuration.Method: POST + Configuration.Triggers: + - keyword1 + - keyword2 + Configuration.RetryCount: 5 delete: description: '' parameters: @@ -1977,8 +2272,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannelWebhook - x-maturity: - - GA /v2/Credentials: servers: - url: https://chat.twilio.com @@ -2024,34 +2317,63 @@ paths: items: $ref: '#/components/schemas/chat.v2.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' responses: @@ -2060,12 +2382,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2113,6 +2444,10 @@ paths: the Firebase console, found under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn /v2/Credentials/{Sid}: servers: - url: https://chat.twilio.com @@ -2141,12 +2476,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' parameters: @@ -2165,12 +2509,21 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2211,6 +2564,10 @@ paths: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' parameters: @@ -2229,8 +2586,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://chat.twilio.com @@ -2240,8 +2595,8 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -2278,12 +2633,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' parameters: @@ -2320,8 +2686,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://chat.twilio.com @@ -2331,8 +2695,8 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -2360,12 +2724,23 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2389,6 +2764,11 @@ paths: assigned to the new member. required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -2419,6 +2799,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2451,34 +2838,65 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://chat.twilio.com @@ -2488,8 +2906,8 @@ paths: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -2524,12 +2942,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' parameters: @@ -2570,8 +3001,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' parameters: @@ -2612,12 +3041,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 20 + last_consumption_timestamp: '2016-03-24T21:05:52Z' + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2661,6 +3103,15 @@ paths: type: string description: A valid JSON string that contains application-specific data. + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2016-03-24T21:05:50Z' + DateUpdated: '2016-03-24T21:05:51Z' + LastConsumedMessageIndex: 20 + LastConsumptionTimestamp: '2016-03-24T21:05:52Z' + Attributes: '{}' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://chat.twilio.com @@ -2670,8 +3121,8 @@ paths: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -2705,12 +3156,25 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2768,6 +3232,11 @@ paths: data. required: - Identity + examples: + create: + value: + Identity: Twilio + Attributes: '{}' get: description: '' parameters: @@ -2830,34 +3299,67 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://chat.twilio.com @@ -2868,8 +3370,8 @@ paths: - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -2906,12 +3408,51 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' parameters: @@ -2954,8 +3495,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' parameters: @@ -2998,12 +3537,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "foo": "bar" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: fromUser + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3041,6 +3597,15 @@ paths: type: string description: The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. + examples: + update: + value: + Body: Hello + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + From: fromUser /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://chat.twilio.com @@ -3051,8 +3616,8 @@ paths: - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -3086,12 +3651,69 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAll: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: system + attributes: '{"test": "test"}' + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3136,6 +3758,20 @@ paths: pattern: ^ME[0-9a-fA-F]{32}$ description: The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message. + examples: + create: + value: + Body: Hello + createWithAll: + value: + Body: Hello + Attributes: '{"test": "test"}' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + createMedia: + value: + MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -3196,34 +3832,91 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v2/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://chat.twilio.com @@ -3233,8 +3926,8 @@ paths: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -3263,12 +3956,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' parameters: @@ -3297,8 +4004,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' parameters: @@ -3327,12 +4032,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3353,6 +4072,10 @@ paths: this parameter depend on the role's `type`. required: - Permission + examples: + update: + value: + Permission: sendMessage /v2/Services/{ServiceSid}/Roles: servers: - url: https://chat.twilio.com @@ -3362,8 +4085,8 @@ paths: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -3383,12 +4106,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3418,6 +4155,12 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' parameters: @@ -3463,34 +4206,68 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v2/Services/{Sid}: servers: - url: https://chat.twilio.com @@ -3500,12 +4277,12 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' binding: '{service_sid: sid}' + pathType: instance get: description: '' parameters: @@ -3524,12 +4301,45 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' parameters: @@ -3548,8 +4358,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' parameters: @@ -3568,12 +4376,59 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: + log_enabled: true + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + badge_count_enabled: true + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: new media compatibility message description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3745,6 +4600,37 @@ paths: Notifications.LogEnabled: type: boolean description: Whether to log notifications. The default is `false`. + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.NewMessage.BadgeCountEnabled: true + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Notifications.LogEnabled: true + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + PreWebhookRetryCount: 2 + PostWebhookRetryCount: 3 + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Media.CompatibilityMessage: new media compatibility message /v2/Services: servers: - url: https://chat.twilio.com @@ -3754,12 +4640,12 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' binding: '{service_sid: sid}' + pathType: list post: description: '' responses: @@ -3768,12 +4654,45 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3787,6 +4706,10 @@ paths: new resource. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' parameters: @@ -3822,34 +4745,87 @@ paths: items: $ref: '#/components/schemas/chat.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://chat.twilio.com/v2/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://chat.twilio.com @@ -3860,11 +4836,11 @@ paths: - friendly_name - identity - date_created - pathType: instance dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' user_binding: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -3891,12 +4867,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' parameters: @@ -3923,8 +4916,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' parameters: @@ -3957,12 +4948,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3985,6 +4993,12 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is often used for display purposes. + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v2/Services/{ServiceSid}/Users: servers: - url: https://chat.twilio.com @@ -3995,11 +5009,11 @@ paths: - friendly_name - identity - date_created - pathType: list dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' user_binding: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -4025,12 +5039,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4062,6 +5093,13 @@ paths: new resource. This value is often used for display purposes. required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' parameters: @@ -4107,34 +5145,71 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: servers: - url: https://chat.twilio.com @@ -4145,9 +5220,9 @@ paths: - endpoint - identity - binding_type - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: list get: description: '' parameters: @@ -4211,34 +5286,71 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.user.user_binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}: servers: - url: https://chat.twilio.com @@ -4249,9 +5361,9 @@ paths: - endpoint - identity - binding_type - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: instance get: description: '' parameters: @@ -4288,12 +5400,29 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserBinding - x-maturity: - - GA delete: description: '' parameters: @@ -4330,8 +5459,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://chat.twilio.com @@ -4340,9 +5467,9 @@ paths: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: List all Channels for a given User. parameters: @@ -4396,34 +5523,68 @@ paths: items: $ref: '#/components/schemas/chat.v2.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: servers: - url: https://chat.twilio.com @@ -4432,9 +5593,9 @@ paths: defaultOutputProperties: - channel_sid - status - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: instance get: description: '' parameters: @@ -4470,12 +5631,26 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_channel' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserChannel - x-maturity: - - GA delete: description: Removes User from selected Channel. parameters: @@ -4515,8 +5690,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserChannel - x-maturity: - - GA post: description: '' parameters: @@ -4552,12 +5725,41 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_channel' + examples: + updateNotificationLevel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: muted + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 10 + unread_messages_count: 5 + notification_level: muted + url: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUserChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4582,8 +5784,12 @@ paths: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). + examples: + updateNotificationLevel: + value: + NotificationLevel: muted + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 10 servers: - url: https://chat.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index 16ba1958..4ff269b5 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: chat.v3.channel: type: object @@ -94,10 +98,6 @@ components: enum: - 'true' - 'false' - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Chat description: This is the public Twilio REST API. @@ -109,7 +109,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v3/Services/{ServiceSid}/Channels/{Sid}: @@ -153,12 +153,27 @@ paths: application/json: schema: $ref: '#/components/schemas/chat.v3.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://chat.twilio.com/v3/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -178,6 +193,11 @@ paths: pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to. + examples: + update: + value: + Type: private + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v3/Services/{ServiceSid}/Channels: servers: - url: https://chat.twilio.com @@ -191,6 +211,3 @@ paths: pathType: list servers: - url: https://chat.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_content_v1.yaml b/spec/yaml/twilio_content_v1.yaml index 17a842a8..f1e85823 100644 --- a/spec/yaml/twilio_content_v1.yaml +++ b/spec/yaml/twilio_content_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: content.v1.content.approval_fetch: type: object @@ -207,10 +211,6 @@ components: format: uri nullable: true description: The URL of the resource, relative to `https://content.twilio.com`. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Content description: This is the public Twilio REST API. @@ -222,7 +222,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Content/{Sid}/ApprovalRequests: @@ -235,9 +235,9 @@ paths: - sid - account_sid - whatsapp - pathType: instance parent: /Content/{Sid} mountName: approval_fetch + pathType: instance get: description: Fetch a Content resource's approval status by its unique Content Sid @@ -258,12 +258,24 @@ paths: application/json: schema: $ref: '#/components/schemas/content.v1.content.approval_fetch' + examples: + getApproval: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + whatsapp: + type: whatsapp + name: tree_fiddy + category: ACCOUNT_UPDATE + content_type: twilio/location + status: approved + rejection_reason: '' + allow_category_change: true + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests description: OK security: - accountSid_authToken: [] operationId: FetchApprovalFetch - x-maturity: - - Preview /v1/Content/{Sid}: servers: - url: https://content.twilio.com @@ -278,11 +290,11 @@ paths: - language - variables - types - pathType: instance dependentProperties: - content/v1/approval_create: '{sid: sid}' + approval_create: '{sid: sid}' approval_fetch: '{sid: sid}' mountName: contents + pathType: instance get: description: Fetch a Content resource by its unique Content Sid parameters: @@ -302,12 +314,32 @@ paths: application/json: schema: $ref: '#/components/schemas/content.v1.content' + examples: + fetch: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests description: OK security: - accountSid_authToken: [] operationId: FetchContent - x-maturity: - - Preview delete: description: Deletes a Content resource parameters: @@ -327,8 +359,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteContent - x-maturity: - - Preview /v1/Content: servers: - url: https://content.twilio.com @@ -343,11 +373,11 @@ paths: - language - variables - types - pathType: list dependentProperties: - content/v1/approval_create: '{sid: sid}' + approval_create: '{sid: sid}' approval_fetch: '{sid: sid}' mountName: contents + pathType: list get: description: Retrieve a list of Contents belonging to the account used to make the request @@ -384,34 +414,112 @@ paths: items: $ref: '#/components/schemas/content.v1.content' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/Content?PageSize=10&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/Content?PageSize=10&Page=0 + next_page_url: null + key: contents + readResults: + value: + contents: + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Anotha content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Third content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/Content?PageSize=20&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/Content?PageSize=20&Page=0 + next_page_url: null + key: contents description: OK security: - accountSid_authToken: [] operationId: ListContent - x-maturity: - - Preview /v1/ContentAndApprovals: servers: - url: https://content.twilio.com @@ -428,8 +536,8 @@ paths: - variables - types - approval_requests - pathType: list className: content_and_approvals + pathType: list get: description: Retrieve a list of Contents with approval statuses belonging to the account used to make the request @@ -466,34 +574,127 @@ paths: items: $ref: '#/components/schemas/content.v1.content_and_approvals' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0 + previous_page_url: null + next_page_url: null + url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0 + key: contents + readResults: + value: + contents: + - date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + approval_requests: + name: '' + category: '' + content_type: '' + status: unsubmitted + rejection_reason: '' + allow_category_change: true + - language: en + date_updated: '2023-01-13T23:33:46Z' + variables: + '1': name + '2': typedocument + friendly_name: Media Test + account_sid: AC25c0d4b9093547216c460212e24e77ee + sid: HX5fcd48a417c1cb59da349ad6d5da4607 + date_created: '2023-01-13T23:33:46Z' + types: + twilio/media: + body: '{{1}}, Congratulations {{2}}! For additional assistance, + please contact us at hello@twilio.com' + media: + - https://example.com/template + approval_requests: + category: TRANSACTIONAL + status: approved + rejection_reason: '' + name: Media Test + content_type: twilio/media + allow_category_change: false + - language: en + date_updated: '2023-01-18T02:46:35Z' + variables: + '1': name + '2': type_video + '3': small.mp4 + friendly_name: Video Highlights + account_sid: AC25c0d4b9093547216c460212e24e77ee + sid: HX15c711fcc6d9ea5268d7ab77938a20ff + date_created: '2023-01-18T02:46:35Z' + types: + twilio/media: + body: Hi there, {{1}}, we have received your request to + upload {{2}}, and should be uploaded shortly. + media: + - http://example.com/highlights/{{3}} + approval_requests: + category: TRANSACTIONAL + status: rejected + rejection_reason: 'INVALID_FORMAT. Facebook is not able to + create template with templateName=Video Highlights_hx15c711fcc6d9ea5268d7ab77938a20ff + due to the following error: Invalid parameter. More Details: + Message template ''components'' param is missing expected + field(s). component of type HEADER is missing expected field(s) + (example)' + name: Video Highlights + content_type: twilio/media + allow_category_change: true + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0 + url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0 + previous_page_url: null + next_page_url: null + key: contents description: OK security: - accountSid_authToken: [] operationId: ListContentAndApprovals - x-maturity: - - Preview /v1/LegacyContent: servers: - url: https://content.twilio.com @@ -510,8 +711,8 @@ paths: - types - legacy_template_name - legacy_body - pathType: list mountName: legacy_contents + pathType: list get: description: Retrieve a list of Legacy Contents belonging to the account used to make the request @@ -548,38 +749,108 @@ paths: items: $ref: '#/components/schemas/content.v1.legacy_content' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0 + next_page_url: null + key: contents + readResults: + value: + contents: + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + legacy_template_name: legacy_template_1 + legacy_body: a body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Anotha content + language: en + variables: + name: foo + legacy_template_name: legacy_template_2 + legacy_body: another body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Third content + language: en + variables: + name: foo + legacy_template_name: legacy_template_3 + legacy_body: a third body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0 + next_page_url: null + key: contents description: OK security: - accountSid_authToken: [] operationId: ListLegacyContent - x-maturity: - - Preview servers: - url: https://content.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 51c22be3..aadf8ad4 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: conversations.v1.configuration: type: object @@ -607,6 +611,16 @@ components: enum: - GET - POST + conversation_webhook_enum_target: + type: string + enum: + - webhook + - flex + conversation_webhook_enum_method: + type: string + enum: + - GET + - POST conversations.v1.credential: type: object properties: @@ -2177,10 +2191,6 @@ components: - inactive - active - closed - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Conversations description: This is the public Twilio REST API. @@ -2192,7 +2202,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Configuration: @@ -2214,12 +2224,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_inactive_timer: PT1M + default_closed_timer: PT10M + url: https://conversations.twilio.com/v1/Configuration + links: + service: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + webhooks: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchConfiguration - x-maturity: - - GA post: description: Update the global configuration of conversations on your account responses: @@ -2228,12 +2248,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_inactive_timer: PT1M + default_closed_timer: PT10M + url: https://conversations.twilio.com/v1/Configuration + links: + service: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + webhooks: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2265,6 +2295,13 @@ paths: description: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. + examples: + update: + value: + DefaultChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultMessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultInactiveTimer: PT1M + DefaultClosedTimer: PT10M /v1/Configuration/Addresses: servers: - url: https://conversations.twilio.com @@ -2276,8 +2313,8 @@ paths: - type - address - friendly_name - pathType: list mountName: address_configurations + pathType: list get: description: Retrieve a list of address configurations for an account parameters: @@ -2287,6 +2324,9 @@ paths: be one of: `whatsapp`, `sms`.' schema: type: string + examples: + readByAddressType: + value: sms - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2319,34 +2359,156 @@ paths: items: $ref: '#/components/schemas/conversations.v1.configuration_address' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + next_page_url: null + key: address_configurations + address_configurations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + address: '+37256123458' + type: sms + friendly_name: Studio Test Configuration + address_country: US + auto_creation: + enabled: false + type: studio + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + address: '+37256123459' + type: sms + friendly_name: Default Test Configuration + address_country: NG + auto_creation: + enabled: true + type: default + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + readBlank: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: address_configurations + address_configurations: [] + readByAddressType: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0 + next_page_url: null + key: address_configurations + address_configurations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + address: '+37256123458' + type: sms + friendly_name: Studio Test Configuration + address_country: US + auto_creation: + enabled: false + type: studio + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + address: '+37256123459' + type: sms + friendly_name: Default Test Configuration + address_country: NG + auto_creation: + enabled: true + type: default + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac description: OK security: - accountSid_authToken: [] operationId: ListConfigurationAddress - x-maturity: - - GA post: description: Create a new address configuration responses: @@ -2355,12 +2517,31 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateConfigurationAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2431,6 +2612,21 @@ paths: required: - Type - Address + examples: + create: + value: + Address: '+37256123457' + Type: sms + FriendlyName: My Test Configuration + AutoCreation.Enabled: true + AutoCreation.Type: webhook + AutoCreation.ConversationServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AutoCreation.WebhookUrl: https://example.com + AutoCreation.WebhookMethod: POST + AutoCreation.WebhookFilters: + - onParticipantAdded + - onMessageAdded + AddressCountry: CA /v1/Configuration/Addresses/{Sid}: servers: - url: https://conversations.twilio.com @@ -2442,8 +2638,8 @@ paths: - type - address - friendly_name - pathType: instance mountName: address_configurations + pathType: instance get: description: 'Fetch an address configuration ' parameters: @@ -2460,12 +2656,31 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration + address_country: CA + auto_creation: + enabled: true + type: webhook + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: https://example.com + webhook_method: POST + webhook_filters: + - onParticipantAdded + - onMessageAdded + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConfigurationAddress - x-maturity: - - GA post: description: Update an existing address configuration parameters: @@ -2482,12 +2697,28 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: '+37256123457' + type: sms + friendly_name: My Test Configuration Updated + address_country: CA + auto_creation: + enabled: false + type: studio + conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + studio_retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateConfigurationAddress - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2543,6 +2774,14 @@ paths: type: integer description: For type `studio`, number of times to retry the webhook request + examples: + update: + value: + FriendlyName: My Test Configuration Updated + AutoCreation.Enabled: false + AutoCreation.Type: studio + AutoCreation.StudioFlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AutoCreation.StudioRetryCount: 3 delete: description: Remove an existing address configuration parameters: @@ -2559,8 +2798,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConfigurationAddress - x-maturity: - - GA /v1/Configuration/Webhooks: servers: - url: https://conversations.twilio.com @@ -2572,8 +2809,8 @@ paths: - method - pre_webhook_url - post_webhook_url - pathType: instance parent: /Configuration + pathType: instance get: description: '' responses: @@ -2582,12 +2819,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration.configuration_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://example.com/pre + post_webhook_url: https://example.com/post + method: GET + filters: + - onMessageSend + - onConversationUpdated + target: webhook + url: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchConfigurationWebhook - x-maturity: - - GA post: description: '' responses: @@ -2596,12 +2843,21 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration.configuration_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://example.com/pre + post_webhook_url: http://example.com/post + method: GET + filters: + - onConversationUpdated + target: webhook + url: https://conversations.twilio.com/v1/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateConfigurationWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2632,6 +2888,15 @@ paths: type: string $ref: '#/components/schemas/configuration_webhook_enum_target' description: The routing target of the webhook. + examples: + update: + value: + PreWebhookUrl: https://example.com/pre + PostWebhookUrl: https://example.com/post + Method: GET + Filters: + - onConversationUpdated + Target: webhook /v1/Conversations: servers: - url: https://conversations.twilio.com @@ -2643,11 +2908,11 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list dependentProperties: participant: '{conversation_sid: sid}' message: '{conversation_sid: sid}' webhook: '{conversation_sid: sid}' + pathType: list post: description: Create a new conversation in your account's default service parameters: @@ -2663,12 +2928,51 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + createNoTimersNoAttributes: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: null + attributes: '{}' + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + state: active + timers: {} + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: Created security: - accountSid_authToken: [] operationId: CreateConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2719,6 +3023,25 @@ paths: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "topic": "feedback" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + State: inactive + Timers.Inactive: PT1M + Timers.Closed: PT10M + createNoTimersNoAttributes: + value: + FriendlyName: friendly_name + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + State: active get: description: Retrieve a list of conversations in your account's default service parameters: @@ -2775,34 +3098,63 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + conversations: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Home Repair Visit + unique_name: null + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListConversation - x-maturity: - - GA /v1/Conversations/{Sid}: servers: - url: https://conversations.twilio.com @@ -2814,11 +3166,11 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance dependentProperties: participant: '{conversation_sid: sid}' message: '{conversation_sid: sid}' webhook: '{conversation_sid: sid}' + pathType: instance post: description: Update an existing conversation in your account's default service parameters: @@ -2841,12 +3193,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2897,6 +3269,18 @@ paths: 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. + examples: + update: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "topic": "feedback" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + State: inactive + Timers.Inactive: PT1M + Timers.Closed: PT10M delete: description: Remove a conversation from your account's default service parameters: @@ -2919,8 +3303,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversation - x-maturity: - - GA get: description: Fetch a conversation from your account's default service parameters: @@ -2937,12 +3319,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My First Conversation + unique_name: first_conversation + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchConversation - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com @@ -2953,10 +3355,10 @@ paths: - index - author - date_created - pathType: list dependentProperties: delivery_receipt: '{conversation_sid: conversation_sid, message_sid: sid}' parent: /Conversations/{Sid} + pathType: list post: description: Add a new message to the conversation parameters: @@ -2979,12 +3381,111 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + createWithMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: null + media: + - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 42056 + content_type: image/jpeg + filename: car.jpg + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + createNoAttributes: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + createWithContentSid: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello John + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: Created security: - accountSid_authToken: [] operationId: CreateConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3034,6 +3535,34 @@ paths: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. + examples: + create: + value: + Body: Hello + Author: message author + Attributes: '{ "importance": "high" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createWithMedia: + value: + MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Author: message author + Attributes: '{ "importance": "high" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createNoAttributes: + value: + Body: Hello + Author: message author + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + createWithContentSid: + value: + Author: message author + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + ContentSid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ContentVariables: '{"name": "John"}' get: description: Retrieve a list of all messages in the conversation parameters: @@ -3051,6 +3580,9 @@ paths: schema: type: string $ref: '#/components/schemas/conversation_message_enum_order_type' + examples: + readLastMessage: + value: desc - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3083,34 +3615,151 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: I like pie. + media: null + author: pie_preferrer + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Cake is my favorite! + media: null + author: cake_lover + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:38:21Z' + date_updated: '2016-03-24T20:38:21Z' + index: 5 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: null + media: + - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 42056 + content_type: image/jpeg + filename: car.jpg + author: cake_lover + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:38:21Z' + date_updated: '2016-03-24T20:38:21Z' + index: 9 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + readLastMessage: + value: + meta: + page: 0 + page_size: 1 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 + next_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=1&PageToken=PAIMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: null + media: + - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 42056 + content_type: image/jpeg + filename: car.jpg + author: cake_lover + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:38:21Z' + date_updated: '2016-03-24T20:38:21Z' + index: 9 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: OK security: - accountSid_authToken: [] operationId: ListConversationMessage - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com @@ -3121,10 +3770,10 @@ paths: - index - author - date_created - pathType: instance dependentProperties: delivery_receipt: '{conversation_sid: conversation_sid, message_sid: sid}' parent: /Conversations/{Sid} + pathType: instance post: description: Update an existing message in the conversation parameters: @@ -3156,12 +3805,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: OK security: - accountSid_authToken: [] operationId: UpdateConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3192,6 +3864,14 @@ paths: you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + examples: + update: + value: + Body: Hello + Author: message author + Attributes: '{ "importance": "high" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' delete: description: Remove a message from the conversation parameters: @@ -3223,8 +3903,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversationMessage - x-maturity: - - GA get: description: Fetch a message from the conversation parameters: @@ -3250,12 +3928,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Welcome! + media: null + author: system + participant_sid: null + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: OK security: - accountSid_authToken: [] operationId: FetchConversationMessage - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com @@ -3267,9 +3968,9 @@ paths: - message_sid - status - date_created - pathType: instance parent: /Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: instance get: description: Fetch the delivery and read receipts of the conversation message parameters: @@ -3305,12 +4006,24 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt' + examples: + fetch: + value: + sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConversationMessageReceipt - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com @@ -3322,9 +4035,9 @@ paths: - message_sid - status - date_created - pathType: list parent: /Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: list get: description: Retrieve a list of all delivery and read receipts of the conversation message @@ -3378,34 +4091,77 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + next_page_url: null + key: delivery_receipts + delivery_receipts: + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListConversationMessageReceipt - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com @@ -3414,8 +4170,8 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: list parent: /Conversations/{Sid} + pathType: list post: description: Add a new participant to the conversation parameters: @@ -3438,12 +4194,90 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' + examples: + createSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createChat: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsChatNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{}' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsSmsNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{}' + messaging_binding: + type: sms + address: '+15017122661' + role_sid: null + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: Created security: - accountSid_authToken: [] operationId: CreateConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3496,6 +4330,42 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. + examples: + createSms: + value: + Attributes: '{ "role": "driver" }' + MessagingBinding.Address: '+15558675310' + MessagingBinding.ProxyAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createChat: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmms: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmmsChatNoAttributes: + value: + Identity: IDENTITY + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + createGmmsSmsNoAttributes: + value: + MessagingBinding.Address: '+15017122661' + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' get: description: Retrieve a list of all participants of the conversation parameters: @@ -3538,34 +4408,71 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: ListConversationParticipant - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com @@ -3574,8 +4481,8 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: instance parent: /Conversations/{Sid} + pathType: instance post: description: Update an existing participant in the conversation parameters: @@ -3604,12 +4511,44 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + updateGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: id + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: UpdateConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3662,6 +4601,16 @@ paths: description: "Timestamp of last \u201Cread\u201D message in the\ \ [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." + examples: + update: + value: + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + updateGmms: + value: + MessagingBinding.ProjectedAddress: '+15017122661' delete: description: Remove a participant from the conversation parameters: @@ -3690,8 +4639,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversationParticipant - x-maturity: - - GA get: description: Fetch a participant of the conversation parameters: @@ -3714,12 +4661,28 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: FetchConversationParticipant - x-maturity: - - GA /v1/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com @@ -3729,8 +4692,8 @@ paths: defaultOutputProperties: - sid - target - pathType: list parent: /Conversations/{Sid} + pathType: list get: description: Retrieve a list of all webhooks scoped to the conversation parameters: @@ -3773,34 +4736,90 @@ paths: items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListConversationScopedWebhook - x-maturity: - - GA post: description: Create a new webhook scoped to the conversation parameters: @@ -3817,12 +4836,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3866,6 +4899,16 @@ paths: webhook will be replayed. Not set by default required: - Target + examples: + create: + value: + Target: webhook + Configuration.Url: https://example.com + Configuration.Method: get + Configuration.Filters: + - onMessageSent + - onConversationDestroyed + Configuration.ReplayAfter: 7 /v1/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com @@ -3875,8 +4918,8 @@ paths: defaultOutputProperties: - sid - target - pathType: instance parent: /Conversations/{Sid} + pathType: instance get: description: Fetch the configuration of a conversation-scoped webhook parameters: @@ -3902,12 +4945,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConversationScopedWebhook - x-maturity: - - GA post: description: Update an existing conversation-scoped webhook parameters: @@ -3933,12 +4986,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3972,6 +5039,14 @@ paths: pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. + examples: + update: + value: + Configuration.Url: https://example.com + Configuration.Method: post + Configuration.Triggers: + - keyword1 + - keyword2 delete: description: Remove an existing webhook scoped to the conversation parameters: @@ -3997,8 +5072,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConversationScopedWebhook - x-maturity: - - GA /v1/Credentials: servers: - url: https://conversations.twilio.com @@ -4017,12 +5090,21 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4070,6 +5152,10 @@ paths: the Firebase console, found under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn get: description: Retrieve a list of all push notification credentials on your account parameters: @@ -4105,34 +5191,63 @@ paths: items: $ref: '#/components/schemas/conversations.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA /v1/Credentials/{Sid}: servers: - url: https://conversations.twilio.com @@ -4161,12 +5276,21 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4212,6 +5336,10 @@ paths: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: Remove a push notification credential from your account parameters: @@ -4230,8 +5358,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA get: description: Fetch a push notification credential from your account parameters: @@ -4250,12 +5376,21 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA /v1/ParticipantConversations: servers: - url: https://conversations.twilio.com @@ -4279,6 +5414,11 @@ paths: Conversations SDK to communicate. Limited to 256 characters. schema: type: string + examples: + readEmpty: + value: identity + readFullByIdentity: + value: identity - name: Address in: query description: A unique string identifier for the conversation participant who's @@ -4286,6 +5426,9 @@ paths: field of Participant resource. It should be url-encoded. schema: type: string + examples: + readFullByAddress: + value: '+375255555555' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4318,34 +5461,112 @@ paths: items: $ref: '#/components/schemas/conversations.v1.participant_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByIdentity: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_identity: identity + participant_messaging_binding: null + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByAddress: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: null + participant_identity: null + participant_messaging_binding: + address: '+375255555555' + proxy_address: '+12345678910' + type: sms + level: null + name: null + projected_address: null + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListParticipantConversation - x-maturity: - - GA /v1/Roles: servers: - url: https://conversations.twilio.com @@ -4365,12 +5586,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4400,6 +5635,12 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: Conversation Role + Type: conversation + Permission: sendMessage get: description: Retrieve a list of all user roles in your account's default service parameters: @@ -4435,34 +5676,68 @@ paths: items: $ref: '#/components/schemas/conversations.v1.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v1/Roles/{Sid}: servers: - url: https://conversations.twilio.com @@ -4492,12 +5767,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4518,6 +5807,10 @@ paths: this parameter depend on the role's `type`. required: - Permission + examples: + update: + value: + Permission: sendMessage delete: description: Remove a user role from your account's default service parameters: @@ -4536,8 +5829,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA get: description: Fetch a user role from your account's default service parameters: @@ -4556,12 +5847,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA /v1/Services: servers: - url: https://conversations.twilio.com @@ -4571,7 +5876,6 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: conversation: '{chat_service_sid: sid}' binding: '{chat_service_sid: sid}' @@ -4579,6 +5883,7 @@ paths: role: '{chat_service_sid: sid}' configuration: '{chat_service_sid: sid}' participant_conversation: '{chat_service_sid: sid}' + pathType: list post: description: Create a new conversation service on your account responses: @@ -4587,12 +5892,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' + examples: + create: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4606,6 +5925,10 @@ paths: 256 characters. Optional. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieve a list of all conversation services on your account parameters: @@ -4641,34 +5964,57 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + services: + - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Home Service + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services?PageSize=50&Page=0 + next_page_url: null + key: services description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://conversations.twilio.com @@ -4678,7 +6024,6 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: conversation: '{chat_service_sid: sid}' binding: '{chat_service_sid: sid}' @@ -4686,6 +6031,7 @@ paths: role: '{chat_service_sid: sid}' configuration: '{chat_service_sid: sid}' participant_conversation: '{chat_service_sid: sid}' + pathType: instance delete: description: Remove a conversation service with all its nested resources from your account @@ -4705,8 +6051,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA get: description: Fetch a conversation service from your account parameters: @@ -4725,12 +6069,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' + examples: + fetch: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My First Service + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Bindings/{Sid}: servers: - url: https://conversations.twilio.com @@ -4741,8 +6099,8 @@ paths: - sid - endpoint - identity - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: Remove a push notification binding from the conversation service parameters: @@ -4771,8 +6129,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceBinding - x-maturity: - - GA get: description: Fetch a push notification binding from the conversation service parameters: @@ -4801,12 +6157,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_conversation + - new_message + - added_to_conversation + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceBinding - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Bindings: servers: - url: https://conversations.twilio.com @@ -4817,8 +6188,8 @@ paths: - sid - endpoint - identity - pathType: list parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all push notification bindings in the conversation service @@ -4884,34 +6255,69 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_conversation + - new_message + - added_to_conversation + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListServiceBinding - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Configuration: servers: - url: https://conversations.twilio.com @@ -4920,8 +6326,8 @@ paths: x-twilio: defaultOutputProperties: - chat_service_sid - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: Fetch the configuration of a conversation service parameters: @@ -4940,12 +6346,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' + examples: + fetch: + value: + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reachability_enabled: false + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + links: + notifications: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchServiceConfiguration - x-maturity: - - GA post: description: Update configuration settings of a conversation service parameters: @@ -4964,12 +6380,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' + examples: + update: + value: + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_conversation_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_chat_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reachability_enabled: false + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration + links: + notifications: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5006,6 +6432,13 @@ paths: type: boolean description: Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Conversations Service. The default is `false`. + examples: + update: + value: + DefaultConversationCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultConversationRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChatServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ReachabilityEnabled: false /v1/Services/{ChatServiceSid}/Conversations: servers: - url: https://conversations.twilio.com @@ -5017,12 +6450,12 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list dependentProperties: participant: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' message: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' webhook: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: Create a new conversation in your service parameters: @@ -5048,12 +6481,51 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + createNoTimersNoAttributes: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: null + attributes: '{}' + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + state: active + timers: {} + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5104,6 +6576,25 @@ paths: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "topic": "feedback" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + State: inactive + Timers.Inactive: PT1M + Timers.Closed: PT10M + createNoTimersNoAttributes: + value: + FriendlyName: friendly_name + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + State: active get: description: Retrieve a list of conversations in your service parameters: @@ -5170,34 +6661,63 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + conversations: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Home Repair Visit + unique_name: null + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{Sid}: servers: - url: https://conversations.twilio.com @@ -5209,12 +6729,12 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance dependentProperties: participant: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' message: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' webhook: '{chat_service_sid: chat_service_sid, conversation_sid: sid}' parent: /Services/{Sid} + pathType: instance post: description: Update an existing conversation in your service parameters: @@ -5247,12 +6767,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5303,6 +6843,18 @@ paths: 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. + examples: + update: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "topic": "feedback" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + State: inactive + Timers.Inactive: PT1M + Timers.Closed: PT10M delete: description: Remove a conversation from your service parameters: @@ -5335,8 +6887,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversation - x-maturity: - - GA get: description: Fetch a conversation from your service parameters: @@ -5363,12 +6913,32 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My First Conversation + unique_name: first_conversation + attributes: '{ "topic": "feedback" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + state: active + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + bindings: {} + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com @@ -5380,11 +6950,11 @@ paths: - index - author - date_created - pathType: list dependentProperties: delivery_receipt: '{chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, message_sid: sid}' parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: list post: description: Add a new message to the conversation in a specific service parameters: @@ -5417,12 +6987,115 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + createWithMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: null + media: + - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 42056 + content_type: image/jpeg + filename: car.jpg + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + createNoAttributes: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + createWithContentSid: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello John + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5472,6 +7145,34 @@ paths: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. + examples: + create: + value: + Body: Hello + Author: message author + Attributes: '{ "importance": "high" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createWithMedia: + value: + MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Author: message author + Attributes: '{ "importance": "high" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createNoAttributes: + value: + Body: Hello + Author: message author + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + createWithContentSid: + value: + Author: message author + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + ContentSid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ContentVariables: '{"name": "John"}' get: description: Retrieve a list of all messages in the conversation parameters: @@ -5499,6 +7200,9 @@ paths: schema: type: string $ref: '#/components/schemas/service_conversation_message_enum_order_type' + examples: + readLastMessage: + value: desc - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5531,34 +7235,155 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: I like pie. + media: null + author: pie_preferrer + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Cake is my favorite! + media: null + author: cake_lover + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:38:21Z' + date_updated: '2016-03-24T20:38:21Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: null + media: + - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 42056 + content_type: image/jpeg + filename: car.jpg + author: cake_lover + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:38:21Z' + date_updated: '2016-03-24T20:38:21Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts + readLastMessage: + value: + meta: + page: 0 + page_size: 1 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 + next_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=1&PageToken=PAIMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: null + media: + - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 42056 + content_type: image/jpeg + filename: car.jpg + author: cake_lover + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:38:21Z' + date_updated: '2016-03-24T20:38:21Z' + index: 9 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessage - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com @@ -5570,11 +7395,11 @@ paths: - index - author - date_created - pathType: instance dependentProperties: delivery_receipt: '{chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, message_sid: sid}' parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: instance post: description: Update an existing message in the conversation parameters: @@ -5616,12 +7441,36 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Hello + media: null + author: message author + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "importance": "high" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5652,6 +7501,14 @@ paths: you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + examples: + update: + value: + Body: Hello + Author: message author + Attributes: '{ "importance": "high" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' delete: description: Remove a message from the conversation parameters: @@ -5693,8 +7550,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversationMessage - x-maturity: - - GA get: description: Fetch a message from the conversation parameters: @@ -5730,12 +7585,36 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + body: Welcome! + media: null + author: system + participant_sid: null + attributes: '{ "importance": "high" }' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + index: 0 + delivery: + total: 2 + sent: all + delivered: some + read: some + failed: none + undelivered: none + content_sid: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessage - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com @@ -5747,9 +7626,9 @@ paths: - message_sid - status - date_created - pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: instance get: description: Fetch the delivery and read receipts of the conversation message parameters: @@ -5795,12 +7674,25 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' + examples: + fetch: + value: + sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessageReceipt - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com @@ -5812,9 +7704,9 @@ paths: - message_sid - status - date_created - pathType: list parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts + pathType: list get: description: Retrieve a list of all delivery and read receipts of the conversation message @@ -5878,34 +7770,80 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 + next_page_url: null + key: delivery_receipts + delivery_receipts: + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 3000 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessageReceipt - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com @@ -5915,8 +7853,8 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: list parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: list post: description: Add a new participant to the conversation in a specific service parameters: @@ -5949,12 +7887,95 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' + examples: + createSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: 'null' + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createChat: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsChatNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{}' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + createGmmsSmsNoAttributes: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{}' + messaging_binding: + type: sms + address: '+15017122661' + role_sid: null + date_created: '2020-07-01T22:18:37Z' + date_updated: '2020-07-01T22:18:37Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6007,6 +8028,42 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. + examples: + createSms: + value: + Attributes: '{ "role": "driver" }' + MessagingBinding.Address: '+15558675310' + MessagingBinding.ProxyAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createChat: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmms: + value: + Identity: IDENTITY + Attributes: '{ "role": "driver" }' + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + createGmmsChatNoAttributes: + value: + Identity: IDENTITY + MessagingBinding.ProjectedAddress: '+15017122661' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' + createGmmsSmsNoAttributes: + value: + MessagingBinding.Address: '+15017122661' + DateCreated: '2020-07-01T22:18:37Z' + DateUpdated: '2020-07-01T22:18:37Z' get: description: Retrieve a list of all participants of the conversation parameters: @@ -6059,34 +8116,73 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: IDENTITY + attributes: '{ "role": "driver" }' + messaging_binding: null + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationParticipant - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com @@ -6096,8 +8192,8 @@ paths: defaultOutputProperties: - sid - messaging_binding - pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: instance post: description: Update an existing participant in the conversation parameters: @@ -6136,12 +8232,46 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null + updateGmms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: id + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + projected_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6194,6 +8324,16 @@ paths: description: "Timestamp of last \u201Cread\u201D message in the\ \ [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." + examples: + update: + value: + Attributes: '{ "role": "driver" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + updateGmms: + value: + MessagingBinding.ProjectedAddress: '+15017122661' delete: description: Remove a participant from the conversation parameters: @@ -6232,8 +8372,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversationParticipant - x-maturity: - - GA get: description: Fetch a participant of the conversation parameters: @@ -6266,12 +8404,29 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: null + attributes: '{ "role": "driver" }' + messaging_binding: + type: sms + address: '+15558675310' + proxy_address: '+15017122661' + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_read_message_index: null + last_read_timestamp: null description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationParticipant - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com @@ -6281,8 +8436,8 @@ paths: defaultOutputProperties: - sid - target - pathType: list parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: list post: description: Create a new webhook scoped to the conversation in a specific service parameters: @@ -6309,12 +8464,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6358,6 +8528,16 @@ paths: webhook will be replayed. Not set by default required: - Target + examples: + create: + value: + Target: webhook + Configuration.Url: https://example.com + Configuration.Method: get + Configuration.Filters: + - onMessageSent + - onConversationDestroyed + Configuration.ReplayAfter: 7 get: description: Retrieve a list of all webhooks scoped to the conversation parameters: @@ -6410,34 +8590,93 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: webhook + configuration: + url: https://example.com + method: get + filters: + - onMessageSent + - onConversationDestroyed + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationScopedWebhook - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com @@ -6447,8 +8686,8 @@ paths: defaultOutputProperties: - sid - target - pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{Sid} + pathType: instance post: description: Update an existing conversation-scoped webhook parameters: @@ -6484,12 +8723,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: trigger + configuration: + url: https://example.com + method: post + filters: + - keyword1 + - keyword2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationScopedWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6523,6 +8777,14 @@ paths: pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. + examples: + update: + value: + Configuration.Url: https://example.com + Configuration.Method: post + Configuration.Triggers: + - keyword1 + - keyword2 delete: description: Remove an existing webhook scoped to the conversation parameters: @@ -6558,8 +8820,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceConversationScopedWebhook - x-maturity: - - GA get: description: Fetch the configuration of a conversation-scoped webhook parameters: @@ -6595,12 +8855,23 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationScopedWebhook - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Configuration/Notifications: servers: - url: https://conversations.twilio.com @@ -6609,8 +8880,8 @@ paths: x-twilio: defaultOutputProperties: - chat_service_sid - pathType: instance parent: /Services/{ChatServiceSid}/Configuration + pathType: instance post: description: Update push notification service settings parameters: @@ -6630,12 +8901,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + log_enabled: true + added_to_conversation: + enabled: false + template: 'You have been added to a Conversation: ${CONVERSATION}' + sound: ring + new_message: + enabled: false + template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: + ${MESSAGE}' + badge_count_enabled: true + sound: ring + with_media: + enabled: false + template: 'You have a new message in ${CONVERSATION} with + ${MEDIA_COUNT} media files: ${MEDIA}' + removed_from_conversation: + enabled: false + template: 'You have been removed from a Conversation: ${CONVERSATION}' + sound: ring + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications description: OK security: - accountSid_authToken: [] operationId: UpdateServiceNotification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6701,6 +8995,26 @@ paths: description: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`. + examples: + update: + value: + NewMessage.Enabled: false + NewMessage.Template: 'You have a new message in ${CONVERSATION} + from ${PARTICIPANT}: ${MESSAGE}' + NewMessage.Sound: ring + NewMessage.BadgeCountEnabled: true + NewMessage.WithMedia.Enabled: false + NewMessage.WithMedia.Template: 'You have a new message in ${CONVERSATION} + with ${MEDIA_COUNT} media files: ${MEDIA}' + AddedToConversation.Enabled: false + AddedToConversation.Template: 'You have been added to a Conversation: + ${CONVERSATION}' + AddedToConversation.Sound: ring + RemovedFromConversation.Enabled: false + RemovedFromConversation.Template: 'You have been removed from a + Conversation: ${CONVERSATION}' + RemovedFromConversation.Sound: ring + LogEnabled: true get: description: Fetch push notification service settings parameters: @@ -6720,12 +9034,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + log_enabled: false + added_to_conversation: + enabled: true + template: 'You have been added to a Conversation: ${CONVERSATION}' + sound: ring + new_message: + enabled: true + template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: + ${MESSAGE}' + badge_count_enabled: false + sound: ring + with_media: + enabled: false + template: 'You have a new message in ${CONVERSATION} with + ${MEDIA_COUNT} media files: ${MEDIA}' + removed_from_conversation: + enabled: true + template: 'You have been removed from a Conversation: ${CONVERSATION}' + sound: ring + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications description: OK security: - accountSid_authToken: [] operationId: FetchServiceNotification - x-maturity: - - GA /v1/Services/{ChatServiceSid}/ParticipantConversations: servers: - url: https://conversations.twilio.com @@ -6736,8 +9073,8 @@ paths: - chat_service_sid - participant_sid - conversation_sid - pathType: list parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. @@ -6760,6 +9097,11 @@ paths: Conversations SDK to communicate. Limited to 256 characters. schema: type: string + examples: + readEmpty: + value: identity + readFullByIdentity: + value: identity - name: Address in: query description: A unique string identifier for the conversation participant who's @@ -6767,6 +9109,9 @@ paths: field of Participant resource. It should be url-encoded. schema: type: string + examples: + readFullByAddress: + value: '+375255555555' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6799,34 +9144,112 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_participant_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByIdentity: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_identity: identity + participant_messaging_binding: null + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFullByAddress: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_friendly_name: friendly_name + conversation_state: inactive + conversation_timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + conversation_attributes: '{}' + conversation_date_created: '2015-07-30T20:00:00Z' + conversation_date_updated: '2015-07-30T20:00:00Z' + conversation_created_by: created_by + conversation_unique_name: unique_name + participant_user_sid: null + participant_identity: null + participant_messaging_binding: + address: '+375255555555' + proxy_address: '+12345678910' + type: sms + level: null + name: null + projected_address: null + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceParticipantConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Roles: servers: - url: https://conversations.twilio.com @@ -6837,8 +9260,8 @@ paths: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new user role in your service parameters: @@ -6858,12 +9281,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateServiceRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6893,6 +9330,12 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: Conversation Role + Type: conversation + Permission: sendMessage get: description: Retrieve a list of all user roles in your service parameters: @@ -6938,34 +9381,68 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListServiceRole - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Roles/{Sid}: servers: - url: https://conversations.twilio.com @@ -6976,8 +9453,8 @@ paths: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: Update an existing user role in your service parameters: @@ -7006,12 +9483,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateServiceRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7032,6 +9523,10 @@ paths: this parameter depend on the role's `type`. required: - Permission + examples: + update: + value: + Permission: sendMessage delete: description: Remove a user role from your service parameters: @@ -7060,8 +9555,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceRole - x-maturity: - - GA get: description: Fetch a user role from your service parameters: @@ -7090,12 +9583,26 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Conversation Role + type: conversation + permissions: + - sendMessage + - leaveConversation + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceRole - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users: servers: - url: https://conversations.twilio.com @@ -7105,10 +9612,10 @@ paths: defaultOutputProperties: - sid - identity - pathType: list dependentProperties: user_conversation: '{chat_service_sid: chat_service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: Add a new conversation user to your service parameters: @@ -7134,12 +9641,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: Created security: - accountSid_authToken: [] operationId: CreateServiceUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7168,6 +9690,13 @@ paths: to assign to the user. required: - Identity + examples: + create: + value: + Identity: admin + FriendlyName: name + Attributes: '{ "duty": "tech" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all conversation users in your service parameters: @@ -7213,34 +9742,72 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: agent0034 + friendly_name: John from customs + attributes: '{ "duty": "agent" }' + is_online: false + is_notifiable: null + date_created: '2020-03-24T20:38:21Z' + date_updated: '2020-03-24T20:38:21Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceUser - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users/{Sid}: servers: - url: https://conversations.twilio.com @@ -7250,10 +9817,10 @@ paths: defaultOutputProperties: - sid - identity - pathType: instance dependentProperties: user_conversation: '{chat_service_sid: chat_service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: instance post: description: Update an existing conversation user in your service parameters: @@ -7286,12 +9853,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: new name + attributes: '{ "duty": "tech", "team": "internals" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7313,6 +9895,12 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. + examples: + update: + value: + FriendlyName: new name + Attributes: '{ "duty": "tech", "team": "internals" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Remove a conversation user from your service parameters: @@ -7345,8 +9933,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceUser - x-maturity: - - GA get: description: Fetch a conversation user from your service parameters: @@ -7373,12 +9959,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: FetchServiceUser - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com @@ -7391,9 +9992,9 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations + pathType: instance post: description: Update a specific User Conversation. parameters: @@ -7427,12 +10028,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUserConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7455,6 +10079,12 @@ paths: nullable: true description: The index of the last Message in the Conversation that the Participant has read. + examples: + update: + value: + NotificationLevel: default + LastReadTimestamp: '2015-07-30T20:00:00Z' + LastReadMessageIndex: 100 delete: description: Delete a specific User Conversation. parameters: @@ -7488,8 +10118,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteServiceUserConversation - x-maturity: - - GA get: description: Fetch a specific User Conversation. parameters: @@ -7523,12 +10151,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchServiceUserConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com @@ -7541,9 +10192,9 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations + pathType: list get: description: Retrieve a list of all User Conversations for the User. parameters: @@ -7596,34 +10247,77 @@ paths: items: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations + readFull: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListServiceUserConversation - x-maturity: - - GA /v1/Services/{ChatServiceSid}/Configuration/Webhooks: servers: - url: https://conversations.twilio.com @@ -7633,8 +10327,8 @@ paths: x-twilio: defaultOutputProperties: - chat_service_sid - pathType: instance parent: /Services/{ChatServiceSid}/Configuration + pathType: instance post: description: Update a specific Webhook. parameters: @@ -7654,12 +10348,22 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://www.example.com/pre + post_webhook_url: https://www.example.com/post + filters: + - onMessageRemoved + - onParticipantAdded + method: GET + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks description: OK security: - accountSid_authToken: [] operationId: UpdateServiceWebhookConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7694,6 +10398,15 @@ paths: type: string description: The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. + examples: + update: + value: + PreWebhookUrl: https://www.example.com/pre + PostWebhookUrl: https://www.example.com/post + Filters: + - onMessageRemoved + - onParticipantAdded + Method: GET get: description: Fetch a specific service webhook configuration. parameters: @@ -7713,12 +10426,31 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + pre_webhook_url: https://www.example.com/pre + post_webhook_url: https://www.example.com/post + filters: + - onMessageRemove + - onParticipantAdd + method: POST + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks + fetchEmpty: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks + pre_webhook_url: null + post_webhook_url: null + filters: null + method: null description: OK security: - accountSid_authToken: [] operationId: FetchServiceWebhookConfiguration - x-maturity: - - GA /v1/Users: servers: - url: https://conversations.twilio.com @@ -7728,9 +10460,9 @@ paths: defaultOutputProperties: - sid - identity - pathType: list dependentProperties: user_conversation: '{user_sid: sid}' + pathType: list post: description: Add a new conversation user to your account's default service parameters: @@ -7746,12 +10478,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7780,6 +10527,13 @@ paths: to assign to the user. required: - Identity + examples: + create: + value: + Identity: admin + FriendlyName: name + Attributes: '{ "duty": "tech" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all conversation users in your account's default service @@ -7816,34 +10570,72 @@ paths: items: $ref: '#/components/schemas/conversations.v1.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: agent0034 + friendly_name: John from customs + attributes: '{ "duty": "agent" }' + is_online: false + is_notifiable: null + date_created: '2020-03-24T20:38:21Z' + date_updated: '2020-03-24T20:38:21Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v1/Users/{Sid}: servers: - url: https://conversations.twilio.com @@ -7853,9 +10645,9 @@ paths: defaultOutputProperties: - sid - identity - pathType: instance dependentProperties: user_conversation: '{user_sid: sid}' + pathType: instance post: description: Update an existing conversation user in your account's default service @@ -7879,12 +10671,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: new name + attributes: '{ "duty": "tech", "team": "internals" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -7906,6 +10713,12 @@ paths: pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. + examples: + update: + value: + FriendlyName: new name + Attributes: '{ "duty": "tech", "team": "internals" }' + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Remove a conversation user from your account's default service parameters: @@ -7928,8 +10741,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA get: description: Fetch a conversation user from your account's default service parameters: @@ -7946,12 +10757,27 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: admin + friendly_name: name + attributes: '{ "duty": "tech" }' + is_online: true + is_notifiable: null + date_created: '2019-12-16T22:18:37Z' + date_updated: '2019-12-16T22:18:38Z' + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA /v1/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com @@ -7964,9 +10790,9 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: instance parent: /Users/{Sid} mountName: user_conversations + pathType: instance post: description: Update a specific User Conversation. parameters: @@ -7990,12 +10816,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user.user_conversation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUserConversation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -8018,6 +10867,12 @@ paths: nullable: true description: The index of the last Message in the Conversation that the Participant has read. + examples: + update: + value: + NotificationLevel: default + LastReadTimestamp: '2015-07-30T20:00:00Z' + LastReadMessageIndex: 100 delete: description: Delete a specific User Conversation. parameters: @@ -8041,8 +10896,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserConversation - x-maturity: - - GA get: description: Fetch a specific User Conversation. parameters: @@ -8066,12 +10919,35 @@ paths: application/json: schema: $ref: '#/components/schemas/conversations.v1.user.user_conversation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserConversation - x-maturity: - - GA /v1/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com @@ -8084,9 +10960,9 @@ paths: - chat_service_sid - friendly_name - date_created - pathType: list parent: /Users/{Sid} mountName: user_conversations + pathType: list get: description: Retrieve a list of all User Conversations for the User. parameters: @@ -8129,36 +11005,76 @@ paths: items: $ref: '#/components/schemas/conversations.v1.user.user_conversation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations + readFull: + value: + conversations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unread_messages_count: 100 + last_read_message_index: 100 + participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + conversation_state: inactive + timers: + date_inactive: '2015-12-16T22:19:38Z' + date_closed: '2015-12-16T22:28:38Z' + attributes: '{}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + notification_level: default + unique_name: unique_name + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + previous_page_url: null + url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListUserConversation - x-maturity: - - GA servers: - url: https://conversations.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 41b4d36c..4a6545f8 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: events.v1.event_type: type: object @@ -252,10 +256,6 @@ components: nullable: true description: Contains a dictionary of URL links to nested resources of this Subscription. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Events description: This is the public Twilio REST API. @@ -267,7 +267,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Types: @@ -279,8 +279,8 @@ paths: - type - schema_id - description - pathType: list mountName: event_types + pathType: list get: description: Retrieve a paginated list of all the available Event Types. parameters: @@ -290,6 +290,9 @@ paths: Types using a given schema. schema: type: string + examples: + readResultsWithSchemaId: + value: Messaging.MessageStatus - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -322,34 +325,102 @@ paths: items: $ref: '#/components/schemas/events.v1.event_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + types: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Types?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Types?PageSize=10&Page=0 + next_page_url: null + key: types + readResults: + value: + types: + - date_created: '2020-08-13T13:28:20Z' + date_updated: '2020-08-13T13:28:20Z' + type: com.twilio.messaging.message.delivered + schema_id: Messaging.MessageStatus + public: true + description: Messaging- delivered message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + - date_created: '2020-08-13T13:28:19Z' + date_updated: '2020-08-13T13:28:19Z' + type: com.twilio.messaging.message.failed + schema_id: Messaging.MessageStatus + public: true + description: Messaging- failed message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Types?PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Types?PageSize=20&Page=0 + next_page_url: null + key: types + readResultsWithSchemaId: + value: + types: + - date_created: '2020-08-13T13:28:20Z' + date_updated: '2020-08-13T13:28:20Z' + type: com.twilio.messaging.message.delivered + schema_id: Messaging.MessageStatus + public: true + description: Messaging- delivered message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + - date_created: '2020-08-13T13:28:19Z' + date_updated: '2020-08-13T13:28:19Z' + type: com.twilio.messaging.message.failed + schema_id: Messaging.MessageStatus + public: true + description: Messaging- failed message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.failed + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Types?SchemaId=Messaging.MessageStatus&PageSize=20&Page=0 + next_page_url: null + key: types description: OK security: - accountSid_authToken: [] operationId: ListEventType - x-maturity: - - Beta /v1/Types/{Type}: servers: - url: https://events.twilio.com @@ -359,8 +430,8 @@ paths: - type - schema_id - description - pathType: instance mountName: event_types + pathType: instance get: description: Fetch a specific Event Type. parameters: @@ -376,12 +447,22 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.event_type' + examples: + fetch: + value: + date_created: '2020-08-13T13:28:20Z' + date_updated: '2020-08-13T13:28:20Z' + type: com.twilio.messaging.message.delivered + schema_id: Messaging.MessageStatus + public: true + description: Messaging- delivered message + url: https://events.twilio.com/v1/Types/com.twilio.messaging.message.delivered + links: + schema: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions description: OK security: - accountSid_authToken: [] operationId: FetchEventType - x-maturity: - - Beta /v1/Schemas/{Id}: servers: - url: https://events.twilio.com @@ -389,9 +470,9 @@ paths: x-twilio: defaultOutputProperties: - id - pathType: instance dependentProperties: schema_version: '{id: id}' + pathType: instance get: description: Fetch a specific schema with its nested versions. parameters: @@ -408,12 +489,19 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.schema' + examples: + fetch: + value: + id: Messaging.MessageStatus + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus + latest_version_date_created: '2020-07-30T20:00:00Z' + latest_version: 1 + links: + versions: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions description: OK security: - accountSid_authToken: [] operationId: FetchSchema - x-maturity: - - Beta /v1/Schemas: servers: - url: https://events.twilio.com @@ -421,9 +509,9 @@ paths: x-twilio: defaultOutputProperties: - id - pathType: list dependentProperties: schema_version: '{id: id}' + pathType: list /v1/Schemas/{Id}/Versions: servers: - url: https://events.twilio.com @@ -433,9 +521,9 @@ paths: - id - schema_version - date_created - pathType: list parent: /Schemas/{Id} className: schema_version + pathType: list get: description: Retrieve a paginated list of versions of the schema. parameters: @@ -478,34 +566,67 @@ paths: items: $ref: '#/components/schemas/events.v1.schema.schema_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + schema_versions: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=10&Page=0 + next_page_url: null + key: schema_versions + readResults: + value: + schema_versions: + - id: Messaging.MessageStatus + schema_version: 1 + public: true + date_created: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1 + raw: https://events-schemas.twilio.com/Messaging.MessageStatus/1 + - id: Messaging.MessageStatus + schema_version: 2 + public: true + date_created: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/2 + raw: https://events-schemas.twilio.com/Messaging.MessageStatus/2 + meta: + page: 0 + page_size: 50 + first_page_url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions?PageSize=50&Page=0 + next_page_url: null + key: schema_versions description: OK security: - accountSid_authToken: [] operationId: ListSchemaVersion - x-maturity: - - Beta /v1/Schemas/{Id}/Versions/{SchemaVersion}: servers: - url: https://events.twilio.com @@ -515,9 +636,9 @@ paths: - id - schema_version - date_created - pathType: instance parent: /Schemas/{Id} className: schema_version + pathType: instance get: description: Fetch a specific schema and version. parameters: @@ -540,12 +661,19 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.schema.schema_version' + examples: + fetch: + value: + id: Messaging.MessageStatus + schema_version: 1 + public: true + date_created: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Schemas/Messaging.MessageStatus/Versions/1 + raw: https://events-schemas.twilio.com/Messaging.MessageStatus/1 description: OK security: - accountSid_authToken: [] operationId: FetchSchemaVersion - x-maturity: - - Beta /v1/Sinks/{Sid}: servers: - url: https://events.twilio.com @@ -559,10 +687,10 @@ paths: - sink_configuration - sink_type - status - pathType: instance dependentProperties: sink_test: '{sid: sid}' sink_validate: '{sid: sid}' + pathType: instance get: description: Fetch a specific Sink. parameters: @@ -581,12 +709,27 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink' + examples: + fetch: + value: + status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: A Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate description: OK security: - accountSid_authToken: [] operationId: FetchSink - x-maturity: - - Beta delete: description: Delete a specific Sink. parameters: @@ -605,8 +748,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSink - x-maturity: - - Beta post: description: Update a specific Sink parameters: @@ -625,12 +766,27 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink' + examples: + update: + value: + status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: My Kinesis Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate description: OK security: - accountSid_authToken: [] operationId: UpdateSink - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -644,6 +800,10 @@ paths: should not contain PII.** required: - Description + examples: + update: + value: + Description: My Kinesis Sink /v1/Sinks: servers: - url: https://events.twilio.com @@ -657,10 +817,10 @@ paths: - sink_configuration - sink_type - status - pathType: list dependentProperties: sink_test: '{sid: sid}' sink_validate: '{sid: sid}' + pathType: list post: description: Create a new Sink responses: @@ -669,12 +829,41 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink' + examples: + create: + value: + status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: My Kinesis Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate + createSegment: + value: + status: initialized + sink_configuration: + write_key: MY_WRITEKEY + description: My segment Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sink_type: segment + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate description: Created security: - accountSid_authToken: [] operationId: CreateSink - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -697,6 +886,18 @@ paths: - Description - SinkConfiguration - SinkType + examples: + create: + value: + Description: My Kinesis Sink + SinkType: kinesis + SinkConfiguration: '{"arn": "arn:aws:kinesis:us-east-1:111111111:stream/test","role_arn": + "arn:aws:iam::111111111:role/Role","external_id": "1234567890"}' + createSegment: + value: + Description: My segment Sink + SinkType: segment + SinkConfiguration: '{"write_key": "MY_WRITEKEY"}' get: description: Retrieve a paginated list of Sinks belonging to the account used to make the request. @@ -707,12 +908,18 @@ paths: used/not used by a subscription. schema: type: boolean + examples: + readResultsInUse: + value: true - name: Status in: query description: A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`. schema: type: string + examples: + readResultsStatus: + value: active - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -745,34 +952,175 @@ paths: items: $ref: '#/components/schemas/events.v1.sink' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sinks: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Sinks?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?PageSize=10&Page=0 + next_page_url: null + key: sinks + readResults: + value: + sinks: + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: A Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T19:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:222222222:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: ANOTHER Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate + - status: active + sink_configuration: + destination: http://example.org/webhook + method: POST + batch_events: true + description: A webhook Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + date_created: '2015-07-30T21:00:00Z' + sink_type: webhook + date_updated: '2015-07-30T21:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Sinks?PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?PageSize=20&Page=0 + next_page_url: null + key: sinks + readResultsInUse: + value: + sinks: + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:111111111:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: A Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T19:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate + - status: initialized + sink_configuration: + arn: arn:aws:kinesis:us-east-1:222222222:stream/test + role_arn: arn:aws:iam::111111111:role/Role + external_id: '1234567890' + description: ANOTHER Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2015-07-30T20:00:00Z' + sink_type: kinesis + date_updated: '2015-07-30T20:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate + - status: active + sink_configuration: + destination: http://example.org/webhook + method: POST + batch_events: true + description: A webhook Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + date_created: '2015-07-30T21:00:00Z' + sink_type: webhook + date_updated: '2015-07-30T21:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?InUse=True&PageSize=20&Page=0 + next_page_url: null + key: sinks + readResultsStatus: + value: + sinks: + - status: active + sink_configuration: + destination: http://example.org/webhook + method: POST + batch_events: true + description: A webhook Sink + sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + date_created: '2015-07-30T21:00:00Z' + sink_type: webhook + date_updated: '2015-07-30T21:00:00Z' + url: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + links: + sink_test: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test + sink_validate: https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0 + next_page_url: null + key: sinks description: OK security: - accountSid_authToken: [] operationId: ListSink - x-maturity: - - Beta /v1/Sinks/{Sid}/Test: servers: - url: https://events.twilio.com @@ -780,9 +1128,9 @@ paths: x-twilio: defaultOutputProperties: - result - pathType: list parent: /Sinks/{Sid} mountName: sink_test + pathType: list post: description: Create a new Sink Test Event for the given Sink. parameters: @@ -802,12 +1150,14 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink.sink_test' + examples: + create: + value: + result: submitted description: Created security: - accountSid_authToken: [] operationId: CreateSinkTest - x-maturity: - - Beta /v1/Sinks/{Sid}/Validate: servers: - url: https://events.twilio.com @@ -815,9 +1165,9 @@ paths: x-twilio: defaultOutputProperties: - result - pathType: list parent: /Sinks/{Sid} mountName: sink_validate + pathType: list post: description: Validate that a test event for a Sink was received. parameters: @@ -837,12 +1187,14 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.sink.sink_validate' + examples: + create: + value: + result: valid description: Created security: - accountSid_authToken: [] operationId: CreateSinkValidate - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -856,6 +1208,10 @@ paths: test event for a Sink being validated. required: - TestId + examples: + create: + value: + TestId: TestID /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents: servers: - url: https://events.twilio.com @@ -866,8 +1222,8 @@ paths: - schema_version - account_sid - subscription_sid - pathType: list parent: /Subscriptions/{Sid} + pathType: list get: description: Retrieve a list of all Subscribed Event types for a Subscription. parameters: @@ -912,34 +1268,65 @@ paths: items: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + types: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=10&Page=0 + next_page_url: null + key: types + readResults: + value: + types: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.failed + schema_version: 15 + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.failed + meta: + page: 0 + page_size: 50 + first_page_url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents?PageSize=50&Page=0 + next_page_url: null + key: types description: OK security: - accountSid_authToken: [] operationId: ListSubscribedEvent - x-maturity: - - Beta post: description: Create a new Subscribed Event type for the subscription parameters: @@ -958,12 +1345,18 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered description: Created security: - accountSid_authToken: [] operationId: CreateSubscribedEvent - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -979,6 +1372,11 @@ paths: description: The schema version that the subscription should use. required: - Type + examples: + create: + value: + Type: com.twilio.messaging.message.delivered + SchemaVersion: 2 /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}: servers: - url: https://events.twilio.com @@ -989,8 +1387,8 @@ paths: - schema_version - account_sid - subscription_sid - pathType: instance parent: /Subscriptions/{Sid} + pathType: instance get: description: Read an Event for a Subscription. parameters: @@ -1015,12 +1413,18 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered description: OK security: - accountSid_authToken: [] operationId: FetchSubscribedEvent - x-maturity: - - Beta post: description: Update an Event for a Subscription. parameters: @@ -1045,12 +1449,18 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription.subscribed_event' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + subscription_sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: com.twilio.messaging.message.delivered + schema_version: 2 + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents/com.twilio.messaging.message.delivered description: OK security: - accountSid_authToken: [] operationId: UpdateSubscribedEvent - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1061,6 +1471,10 @@ paths: SchemaVersion: type: integer description: The schema version that the subscription should use. + examples: + update: + value: + SchemaVersion: 2 delete: description: Remove an event type from a subscription. parameters: @@ -1085,8 +1499,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSubscribedEvent - x-maturity: - - Beta /v1/Subscriptions: servers: - url: https://events.twilio.com @@ -1098,9 +1510,9 @@ paths: - sink_sid - date_created - date_updated - pathType: list dependentProperties: subscribed_event: '{subscription_sid: sid}' + pathType: list get: description: Retrieve a paginated list of Subscriptions belonging to the account used to make the request. @@ -1114,6 +1526,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^DG[0-9a-fA-F]{32}$ + examples: + readResultsFilteredBySinkSid: + value: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1146,48 +1561,127 @@ paths: items: $ref: '#/components/schemas/events.v1.subscription' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + subscriptions: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0 + next_page_url: null + key: subscriptions + readResults: + value: + subscriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Another subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents + meta: + page: 0 + page_size: 20 + first_page_url: https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0 + next_page_url: null + key: subscriptions + readResultsFilteredBySinkSid: + value: + subscriptions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Another subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents + meta: + page: 0 + page_size: 10 + first_page_url: https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0 + previous_page_url: null + url: https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0 + next_page_url: null + key: subscriptions description: OK security: - accountSid_authToken: [] operationId: ListSubscription - x-maturity: - - Beta post: description: Create a new Subscription. + parameters: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/events.v1.subscription' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents description: Created security: - accountSid_authToken: [] operationId: CreateSubscription - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1216,6 +1710,16 @@ paths: - Description - SinkSid - Types + examples: + create: + value: + SinkSid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Description: A subscription + Types: + - '{"type": "com.twilio.messaging.message.delivered","schema_version": + 1}' + - '{"type": "com.twilio.messaging.message.failed","schema_version": + 12}' /v1/Subscriptions/{Sid}: servers: - url: https://events.twilio.com @@ -1227,9 +1731,9 @@ paths: - sink_sid - date_created - date_updated - pathType: instance dependentProperties: subscribed_event: '{subscription_sid: sid}' + pathType: instance get: description: Fetch a specific Subscription. parameters: @@ -1248,12 +1752,22 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: A subscription + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents description: OK security: - accountSid_authToken: [] operationId: FetchSubscription - x-maturity: - - Beta post: description: Update a Subscription. parameters: @@ -1272,12 +1786,22 @@ paths: application/json: schema: $ref: '#/components/schemas/events.v1.subscription' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2020-07-30T20:01:33Z' + sid: DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sink_sid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + description: Updated description + url: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + subscribed_events: https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents description: OK security: - accountSid_authToken: [] operationId: UpdateSubscription - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1296,6 +1820,11 @@ paths: description: The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created. + examples: + update: + value: + SinkSid: DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + Description: Updated description delete: description: Delete a specific Subscription. parameters: @@ -1314,11 +1843,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSubscription - x-maturity: - - Beta servers: - url: https://events.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 2f141f69..80369aa8 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: flex.v1.channel: type: object @@ -1054,10 +1058,6 @@ components: type: string enum: - inactive - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Flex description: This is the public Twilio REST API. @@ -1069,7 +1069,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Channels: @@ -1082,8 +1082,8 @@ paths: - flex_flow_sid - user_sid - task_sid - pathType: list mountName: channel + pathType: list get: description: '' parameters: @@ -1119,34 +1119,63 @@ paths: items: $ref: '#/components/schemas/flex.v1.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: + - flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: [] description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA post: description: '' responses: @@ -1155,12 +1184,21 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.channel' + examples: + create: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1213,6 +1251,19 @@ paths: - Identity - ChatUserFriendlyName - ChatFriendlyName + examples: + create: + value: + FlexFlowSid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Target: def + Identity: abc + ChatUserFriendlyName: friendly2 + ChatFriendlyName: friendly1 + ChatUniqueName: unique + PreEngagementData: '{}' + TaskSid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TaskAttributes: '{}' + LongLived: true /v1/Channels/{Sid}: servers: - url: https://flex-api.twilio.com @@ -1223,8 +1274,8 @@ paths: - flex_flow_sid - user_sid - task_sid - pathType: instance mountName: channel + pathType: instance get: description: '' parameters: @@ -1243,12 +1294,21 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.channel' + examples: + fetch: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' parameters: @@ -1267,8 +1327,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA /v1/Configuration: servers: - url: https://flex-api.twilio.com @@ -1294,12 +1352,326 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + attributes: + main_attribute: some_attribute + status: ok + taskrouter_workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + taskrouter_target_workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + taskrouter_target_taskqueue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + taskrouter_taskqueues: + - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + targettable: true + - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + targettable: false + taskrouter_skills: + - name: sales + multivalue: false + minimum: 0 + maximum: 0 + - name: support + multivalue: true + minimum: 0 + maximum: 10 + taskrouter_worker_channels: + agent: + - name: default + availability: true + capacity: 1 + - name: voice + availability: false + capacity: 2 + supervisor: + - name: default + availability: true + capacity: 2 + taskrouter_worker_attributes: + agent: + region: us-east + supervisor: + region: us + taskrouter_offline_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + runtime_domain: https://flex.twilio.com + messaging_service_instance_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flex_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ui_language: en + ui_attributes: {} + ui_dependencies: {} + ui_version: '1.0' + service_version: '1.0' + call_recording_enabled: true + call_recording_webhook_url: https://www.example.com/call-recording + crm_enabled: true + crm_type: custom + crm_callback_url: https://crm.com/a + crm_fallback_url: https://crm.com/b + crm_attributes: + crm_attribute: some_crm + public_attributes: + public: test + plugin_service_enabled: true + plugin_service_attributes: + agent-logger: ^3.10.5 + typewriter: ^7.0.1 + integrations: + - name: twilio + type: http + active: true + config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' + logo: logo1 + author: somebody1 + - name: twilio-stage + type: http + active: false + config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' + outbound_call_flows: + default: + caller_id: '+12345' + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + location: EE + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_stats_configuration: + default: + service_level_threshold: 20 + short_abandoned_threshold: 5 + reset_timezone: America/New_York + reset_time: 00:00 + queue_configurations: + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reset_timezone: Europe/Tallinn + reset_time: 01:00 + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + reset_timezone: Europe/Paris + reset_time: 02:00 + queue_channel_configurations: + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_level_threshold: 10 + short_abandoned_threshold: 10 + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + service_level_threshold: 30 + short_abandoned_threshold: 15 + serverless_service_sids: + - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + notifications: + enabled: true + mode: whenNotInFocus + markdown: + enabled: false + mode: readOnly + flex_insights_hr: + advanced_reporting_enabled: true + advanced_reporting_workspaces: + - id: ID_1 + timezone: America/Los_Angeles + workspace_id: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - id: ID_2 + timezone: Etc/UTC + url: https://flex-api.twilio.com/v1/Configuration + flex_insights_drilldown: true + flex_url: https://flex.twilio.com + channel_configs: + - address_type: sms + cbm_attachments: + enabled: true + number_of_attachments: 10 + max_file_size: 157286400 + max_total_file_size: 157286400 + accepted_extensions: + - jpg + - jpeg + - png + - gif + - txt + - pdf + - address_type: whatsapp + cbm_attachments: + enabled: true + number_of_attachments: 1 + max_file_size: 16777216 + max_total_file_size: 67108864 + accepted_extensions: + - jpg + - jpeg + - png + - amr + - mp3 + - mp4 + - pdf + - heic + - oga + debugger_integration: + enabled: false + flex_ui_status_report: + enabled: false description: OK security: - accountSid_authToken: [] operationId: FetchConfiguration - x-maturity: - - GA + post: + description: '' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + attributes: + main_attribute: some_attribute + status: ok + taskrouter_workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + taskrouter_target_workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + taskrouter_target_taskqueue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + taskrouter_taskqueues: + - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + targettable: true + - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac + targettable: false + taskrouter_skills: + - name: sales + multivalue: false + minimum: 0 + maximum: 0 + - name: support + multivalue: true + minimum: 0 + maximum: 10 + taskrouter_worker_channels: + agent: + - name: default + availability: true + capacity: 1 + - name: voice + availability: false + capacity: 2 + supervisor: + - name: default + availability: true + capacity: 2 + taskrouter_worker_attributes: + agent: + region: us-east + supervisor: + region: us + taskrouter_offline_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + runtime_domain: https://flex.twilio.com + messaging_service_instance_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flex_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ui_language: en + ui_attributes: {} + ui_dependencies: {} + ui_version: '1.0' + service_version: '1.0' + call_recording_enabled: true + call_recording_webhook_url: https://www.example.com/call-recording + crm_enabled: true + crm_type: custom + crm_callback_url: https://crm.com/a + crm_fallback_url: https://crm.com/b + crm_attributes: + crm_attribute: some_crm + public_attributes: + public: test + plugin_service_enabled: false + plugin_service_attributes: + agent-logger: ^3.10.5 + typewriter: ^7.0.1 + integrations: + - name: twilio + type: http + active: true + config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' + logo: logo1 + author: somebody1 + - name: twilio-stage + type: http + active: false + config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' + outbound_call_flows: + default: + caller_id: '+12345' + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + location: EE + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_stats_configuration: + default: + service_level_threshold: 20 + short_abandoned_threshold: 5 + reset_timezone: America/New_York + reset_time: 00:00 + queue_configurations: + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reset_timezone: Europe/Tallinn + reset_time: 01:00 + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + reset_timezone: Europe/Paris + reset_time: 02:00 + queue_channel_configurations: + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_level_threshold: 10 + short_abandoned_threshold: 10 + - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + service_level_threshold: 30 + short_abandoned_threshold: 15 + serverless_service_sids: + - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + notifications: + enabled: true + mode: whenNotInFocus + markdown: + enabled: false + mode: readOnly + flex_insights_hr: + advanced_reporting_enabled: true + advanced_reporting_workspaces: + - id: ID_1 + timezone: America/Los_Angeles + workspace_id: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - id: ID_2 + timezone: Etc/UTC + url: https://flex-api.twilio.com/v1/Configuration + flex_insights_drilldown: true + flex_url: https://flex.twilio.com + channel_configs: + - address_type: sms + cbm_attachments: + enabled: true + number_of_attachments: 10 + max_file_size: 157286400 + max_total_file_size: 157286400 + accepted_extensions: + - jpg + - jpeg + - png + - gif + - txt + - pdf + debugger_integration: + enabled: false + flex_ui_status_report: + enabled: false + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateConfiguration /v1/FlexFlows: servers: - url: https://flex-api.twilio.com @@ -1310,8 +1682,8 @@ paths: - friendly_name - channel_type - integration_type - pathType: list mountName: flex_flow + pathType: list get: description: '' parameters: @@ -1352,34 +1724,71 @@ paths: items: $ref: '#/components/schemas/flex.v1.flex_flow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + next_page_url: null + key: flex_flows + flex_flows: + - sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 + next_page_url: null + key: flex_flows + flex_flows: [] description: OK security: - accountSid_authToken: [] operationId: ListFlexFlow - x-maturity: - - GA post: description: '' responses: @@ -1388,12 +1797,29 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.flex_flow' + examples: + create: + value: + sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateFlexFlow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1504,6 +1930,19 @@ paths: - FriendlyName - ChatServiceSid - ChannelType + examples: + create: + value: + FriendlyName: friendly_name + ChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelType: sms + ContactIdentity: '12345' + Enabled: true + IntegrationType: studio + Integration.FlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + LongLived: true + JanitorEnabled: true + Integration.RetryCount: 1 /v1/FlexFlows/{Sid}: servers: - url: https://flex-api.twilio.com @@ -1514,8 +1953,8 @@ paths: - friendly_name - channel_type - integration_type - pathType: instance mountName: flex_flow + pathType: instance get: description: '' parameters: @@ -1534,12 +1973,29 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.flex_flow' + examples: + fetch: + value: + sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchFlexFlow - x-maturity: - - GA post: description: '' parameters: @@ -1558,12 +2014,29 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.flex_flow' + examples: + update: + value: + sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + friendly_name: friendly_name + chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_type: sms + contact_identity: '12345' + enabled: true + integration_type: studio + integration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + retry_count: 1 + long_lived: true + janitor_enabled: true + url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateFlexFlow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1670,6 +2143,19 @@ paths: in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise. + examples: + update: + value: + FriendlyName: friendly_name + ChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelType: sms + ContactIdentity: '12345' + Enabled: true + IntegrationType: studio + Integration.FlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + LongLived: true + JanitorEnabled: true + Integration.RetryCount: 1 delete: description: '' parameters: @@ -1688,19 +2174,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFlexFlow - x-maturity: - - GA /v1/Insights/QualityManagement/Assessments: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - assessment_sid - assessment - pathType: list className: assessments + pathType: list post: description: Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for @@ -1717,12 +2201,36 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_assessments' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + user_name: Supervisor + user_email: supervisor@example.com + answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + answer_text: Fair + timestamp: '1657329694199' + assessment: + questionnaire: + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Customer Experience + question: + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Active listening + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInsightsAssessments - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1780,6 +2288,19 @@ paths: - AnswerText - AnswerId - QuestionnaireSid + examples: + create: + value: + CategorySid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CategoryName: Good for Training + SegmentId: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + AgentId: 583fcaa6-a4ef-5447-9077-900421e37a61 + Offset: '6.985619' + MetricId: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MetricName: Active listening + AnswerId: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + AnswerText: Fair + QuestionnaireSid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Get assessments done for a conversation by logged in user parameters: @@ -1793,6 +2314,11 @@ paths: description: The id of the segment. schema: type: string + examples: + readBySegmentId: + value: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + readEmpty: + value: dbdf1f7b-c776-5e78-9676-98a397fb3cdc - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1825,45 +2351,89 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_assessments' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readBySegmentId: + value: + assessments: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + user_name: Supervisor + user_email: supervisor@example.com + answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + answer_text: Fair + timestamp: '1657329694199' + assessment: + questionnaire: + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Customer Experience + question: + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Active listening + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 + key: assessments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 + readEmpty: + value: + assessments: [] + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 + key: assessments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInsightsAssessments - x-maturity: - - Preview /v1/Insights/QualityManagement/Assessments/{AssessmentSid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - assessment_sid - assessment - pathType: instance className: assessments + pathType: instance post: description: Update a specific Assessment assessed earlier parameters: @@ -1887,12 +2457,36 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_assessments' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Supervisor + user_email: supervisor@example.com + answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + answer_text: Fair + timestamp: '1657329694199' + assessment: + questionnaire: + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Customer Experience + question: + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Active listening + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsAssessments - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1913,17 +2507,23 @@ paths: - Offset - AnswerText - AnswerId + examples: + update: + value: + Offset: '6.985619' + AnswerId: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 + AnswerText: Fair /v1/Insights/QualityManagement/Assessments/Comments: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - assessment_sid - comment - pathType: list mountName: insights_assessments_comment + pathType: list post: description: To create a comment assessment for a conversation parameters: @@ -1938,12 +2538,29 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_assessments_comment' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Linda Houghton + user_email: linda.houghton@vacasa.com + timestamp: '1657329694199' + comment: + comment: log0zu0268 + category: + category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInsightsAssessmentsComment - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1976,6 +2593,15 @@ paths: - SegmentId - AgentId - Offset + examples: + create: + value: + CategoryId: 4b4e78e4-4f05-49e2-bf52-0973c5cde418 + CategoryName: Good for Training + Comment: log0zu0268 + SegmentId: dbdf1f7b-c776-5e78-9676-98a397fb3cdc + AgentId: 583fcaa6-a4ef-5447-9077-900421e37a61 + Offset: '6.985619' get: description: To create a comment assessment for a conversation parameters: @@ -1989,11 +2615,19 @@ paths: description: The id of the segment. schema: type: string + examples: + readBySegmentId: + value: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + readEmpty: + value: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 - name: AgentId in: query description: The id of the agent. schema: type: string + examples: + readByAgentId: + value: 5d80ee80-7608-55df-b2b2-5ab5608b9831 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2026,47 +2660,111 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_assessments_comment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readBySegmentId: + value: + comments: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Linda Houghton + user_email: linda.houghton@vacasa.com + timestamp: '1657329694199' + comment: + comment: log0zu0268 + category: + category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 + key: comments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 + readByAgentId: + value: + comments: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + offset: '0.0' + report: true + weight: '1' + agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 + segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 + user_name: Linda Houghton + user_email: linda.houghton@vacasa.com + timestamp: '1657329694199' + comment: + comment: log0zu0268 + category: + category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e + name: Good for Training + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0 + key: comments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0 + readEmpty: + value: + comments: [] + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 + key: comments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInsightsAssessmentsComment - x-maturity: - - Preview /v1/Insights/Conversations: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conversation_id - account_id - segment_count - segments - pathType: list mountName: insights_conversations className: insights_conversations + pathType: list get: description: To get conversation with segment id parameters: @@ -2081,6 +2779,11 @@ paths: to be fetched schema: type: string + examples: + readEmpty: + value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 + readFull: + value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2113,46 +2816,83 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_conversations' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + conversations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + next_page_url: null + key: conversations + readFull: + value: + conversations: + - account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d + conversation_id: 2cb2452a-c6d9-564d-b285-b5404f073031 + segment_count: 2 + segments: + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 + order: 0 + offset: 1.542 + talk_time: 18 + timestamp: '2022-05-11T16:02:27.659Z' + agent_name: First Agent + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + order: 0 + offset: 1.211 + talk_time: 10 + timestamp: '2022-05-21T16:02:27.659Z' + agent_name: Second Agent + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 + next_page_url: null + key: conversations description: OK security: - accountSid_authToken: [] operationId: ListInsightsConversations - x-maturity: - - Preview /v1/Insights/QualityManagement/Questionnaires: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - questionnaire_sid - name - pathType: list mountName: insights_questionnaires className: insights_questionnaires + pathType: list post: description: To create a Questionnaire parameters: @@ -2167,12 +2907,38 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: false + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInsightsQuestionnaires - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2199,6 +2965,15 @@ paths: description: The list of questions sids under a questionnaire required: - Name + examples: + create: + value: + Name: abc + Description: description + Active: false + QuestionSids: + - GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee get: description: To get all questionnaires with questions parameters: @@ -2213,6 +2988,11 @@ paths: not schema: type: boolean + examples: + readEmpty: + value: true + readFull: + value: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2245,46 +3025,153 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_questionnaires' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + questionnaires: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + next_page_url: null + key: questionnaires + readFull: + value: + questionnaires: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: false + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + key: questionnaires + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=True&PageSize=50&Page=0 + readActiveQuestionnaires: + value: + questionnaires: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: efg + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0 + key: questionnaires + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInsightsQuestionnaires - x-maturity: - - Preview /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - questionnaire_sid - name - pathType: instance mountName: insights_questionnaires className: insights_questionnaires + pathType: instance post: description: To update the questionnaire parameters: @@ -2308,12 +3195,38 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsQuestionnaires - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2340,6 +3253,15 @@ paths: description: The list of questions sids under a questionnaire required: - Active + examples: + update: + value: + Name: abc + Description: description + Active: true + QuestionSids: + - GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee delete: description: To delete the questionnaire parameters: @@ -2363,8 +3285,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInsightsQuestionnaires - x-maturity: - - Preview get: description: To get the Questionnaire Detail parameters: @@ -2388,23 +3308,49 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: efg + description: description + active: true + questions: + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + - question: What is the total time + description: time spent + category: + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_name: test cat + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInsightsQuestionnaires - x-maturity: - - Preview /v1/Insights/QualityManagement/Categories: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - category_sid - name - pathType: list mountName: insights_questionnaires_category + pathType: list post: description: To create a category for Questions parameters: @@ -2419,12 +3365,17 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abc + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInsightsQuestionnairesCategory - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2437,6 +3388,10 @@ paths: description: The name of this category. required: - Name + examples: + create: + value: + Name: abc get: description: To get all the categories parameters: @@ -2477,45 +3432,70 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + categories: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + next_page_url: null + key: categories + readFull: + value: + categories: + - category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: Test1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 + next_page_url: null + key: categories description: OK security: - accountSid_authToken: [] operationId: ListInsightsQuestionnairesCategory - x-maturity: - - Preview /v1/Insights/QualityManagement/Categories/{CategorySid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - category_sid - name - pathType: instance mountName: insights_questionnaires_category + pathType: instance post: description: To update the category for Questions parameters: @@ -2539,12 +3519,17 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: abcd + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsQuestionnairesCategory - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2557,6 +3542,10 @@ paths: description: The name of this category. required: - Name + examples: + update: + value: + Name: abcd delete: description: '' parameters: @@ -2580,19 +3569,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInsightsQuestionnairesCategory - x-maturity: - - Preview /v1/Insights/QualityManagement/Questions: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - question_sid - question - pathType: list mountName: insights_questionnaires_question + pathType: list post: description: To create a question for a Category parameters: @@ -2607,12 +3594,41 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + question: What is the total time + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: time spent + category: + category_name: test cat + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + answer_set: + sort: 0 + name: Yes, No + answers: + - sort: 0 + score: 100 + description: Yes. + name: 'Yes' + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + - sort: 1 + score: 0 + description: No or a very poor. + name: 'No' + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + type: select + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInsightsQuestionnairesQuestion - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2643,6 +3659,14 @@ paths: - Question - AnswerSetId - AllowNa + examples: + create: + value: + CategorySid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Question: What is the total time + Description: time spent + AnswerSetId: a6a8a54f-5305-4aec-b92c-a6e429932f58 + AllowNa: false get: description: To get all the question for the given categories parameters: @@ -2661,6 +3685,15 @@ paths: minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: + - FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee + readFull: + value: + - FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2693,45 +3726,94 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + questions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: questions + readFull: + value: + questions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + question: What is the total time + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: time spent + category: + category_name: test cat + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + answer_set: + sort: 0 + name: Yes, No + answers: + - sort: 0 + score: 100 + description: Yes. + name: 'Yes' + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + - sort: 1 + score: 0 + description: No or a very poor. + name: 'No' + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + type: select + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: questions description: OK security: - accountSid_authToken: [] operationId: ListInsightsQuestionnairesQuestion - x-maturity: - - Preview /v1/Insights/QualityManagement/Questions/{QuestionSid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - question_sid - question - pathType: instance mountName: insights_questionnaires_question + pathType: instance post: description: To update the question parameters: @@ -2755,12 +3837,41 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + question: What is the total time + question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: time spent + category: + category_name: test cat + category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + allow_na: false + usage: 0 + answer_set: + sort: 0 + name: Yes, No + answers: + - sort: 0 + score: 100 + description: Yes. + name: 'Yes' + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + - sort: 1 + score: 0 + description: No or a very poor. + name: 'No' + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + type: select + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsQuestionnairesQuestion - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2788,6 +3899,13 @@ paths: description: The answer_set for the question. required: - AllowNa + examples: + update: + value: + Question: What is the total time + Description: time spent + AnswerSetId: a6a8a54f-5305-4aec-b92c-a6e429932f58 + AllowNa: false delete: description: '' parameters: @@ -2811,12 +3929,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInsightsQuestionnairesQuestion - x-maturity: - - Preview /v1/Insights/Segments: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - segment_id @@ -2824,9 +3940,9 @@ paths: - account_id - agent_id - queue - pathType: list mountName: insights_segments className: insights_segments + pathType: list get: description: To get segments for given reservation Ids parameters: @@ -2840,6 +3956,9 @@ paths: description: To unique id of the segment schema: type: string + examples: + readBySegmentId: + value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 - name: ReservationId in: query description: The list of reservation Ids @@ -2850,6 +3969,15 @@ paths: minLength: 34 maxLength: 34 pattern: ^WR[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: + - WReeeff42d5326cfdaa0f7a1181d00f1b1 + - WReeeff42d5326cfdaa0f7a1181d00f1b2 + readByReservationIds: + value: + - WReeeff42d5326cfdaa0f7a1181d00f1b1 + - WReeeff42d5326cfdaa0f7a1181d00f1b2 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2882,46 +4010,126 @@ paths: items: $ref: '#/components/schemas/flex.v1.insights_segments' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + segments: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + next_page_url: null + key: segments + readByReservationIds: + value: + segments: + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + external_id: EV4ab3c50aeeb9dc48c96f7290cf626a37 + queue: Everyone + external_contact: '+13051515226' + external_segment_link_id: null + date: '2022-02-08T08:00:00Z' + account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d + external_segment_link: null + agent_id: 0e4a8059-18a3-5e48-9efb-29ae3213e7fe + agent_phone: '+13051515226' + agent_name: Flex Insights + agent_team_name: Everyone + agent_team_name_in_hierarchy: Everyone + agent_link: null + customer_phone: '+420606078007' + customer_name: '+420606078007' + customer_link: null + segment_recording_offset: null + media: null + assessment_type: + - null + assessment_percentage: + - null + url: https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 + next_page_url: null + key: segments + readBySegmentId: + value: + segments: + - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + external_id: EV4ab3c50aeeb9dc48c96f7290cf626a37 + queue: Everyone + external_contact: '+13051515226' + external_segment_link_id: null + date: '2022-02-08T08:00:00Z' + account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d + external_segment_link: null + agent_id: 0e4a8059-18a3-5e48-9efb-29ae3213e7fe + agent_phone: '+13051515226' + agent_name: Flex Insights + agent_team_name: Everyone + agent_team_name_in_hierarchy: Everyone + agent_link: null + customer_phone: '+420606078007' + customer_name: '+420606078007' + customer_link: null + segment_recording_offset: null + media: null + assessment_type: + - null + assessment_percentage: + - null + url: https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0 + next_page_url: null + key: segments description: OK security: - accountSid_authToken: [] operationId: ListInsightsSegments - x-maturity: - - Preview /v1/Insights/Session: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - workspace_id - session_expiry - session_id - base_url - pathType: instance mountName: insights_session + pathType: instance post: description: To obtain session details for fetching reports and dashboards parameters: @@ -2936,24 +4144,31 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_session' + examples: + create: + value: + session_expiry: '2022-09-27T09:28:01Z' + workspace_id: clbi1eelh1x8z4.......ijpnyu + session_id: "-----BEGIN PGP MESSAGE-----\n\nwcBMA11tX1FL13rp\u2026\ + \u2026kHXd\n=vOBk\n-----END PGP MESSAGE-----\n" + base_url: https://analytics.ytica.com/ + url: https://flex-api.twilio.com/v1/Insights/Session description: Created security: - accountSid_authToken: [] operationId: CreateInsightsSession - x-maturity: - - Preview /v1/Insights/QualityManagement/Settings/AnswerSets: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - answer_sets - answer_set_categories - not_applicable - pathType: list mountName: insights_settings_answer_sets className: insights_settings_answer_sets + pathType: list get: description: To get the Answer Set Settings for an Account parameters: @@ -2968,21 +4183,73 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_settings_answersets' + examples: + read: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/AnswerSets + answer_sets: + - category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + id: a6a8a54f-5305-4aec-b92c-a6e429932f58 + name: Yes, No + sort: 0 + type: select + answers: + - description: Yes. + id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 + name: 'Yes' + score: 100 + sort: 0 + - description: No or a very poor. + id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c + name: 'No' + score: 0 + sort: 1 + - category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 + id: 675e8803-e7ca-4002-97f6-a29490450b1b + name: Good, Poor + sort: 1 + type: select + answers: + - description: Good. + id: 5aa6c6c0-05cf-4952-b9f9-9fdbe18cc79d + name: Good + score: 100 + sort: 0 + - description: Poor. + id: d19f1c36-8331-44cc-9944-e94cb39e35e9 + name: Poor + score: 0 + sort: 1 + answer_set_categories: + - id: 1a8cac56-826c-4f85-ac14-9104811cf184 + name: Two Options + sort: 1 + - id: 10c44902-0e6e-46b6-9378-d4665348b4b7 + name: Three Options + sort: 2 + - id: 10c44902-0e6e-46b6-9378-d4665348b4b8 + name: Rating + sort: 3 + not_applicable: + description: Not applicable for this call + id: 8dc58ae1-16ae-4e17-a357-799d06230fa3 + name: N/A + score: 0 + sort: 0 description: OK security: - accountSid_authToken: [] operationId: FetchInsightsSettingsAnswersets - x-maturity: - - Preview /v1/Insights/QualityManagement/Settings/CommentTags: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - comments - pathType: list mountName: insights_settings_comment + pathType: list get: description: To get the Comment Settings for an Account parameters: @@ -2997,22 +4264,30 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_settings_comment' + examples: + read: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + comments: + - default: false + id: 4c5ba39a-e192-4c5d-a41c-b765a833665b + name: Good + sort: 0 + url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/CommentTags description: OK security: - accountSid_authToken: [] operationId: FetchInsightsSettingsComment - x-maturity: - - Preview /v1/Insights/UserRoles: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - roles - pathType: instance mountName: insights_user_roles className: insights_user_roles + pathType: instance get: description: This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user @@ -3028,23 +4303,27 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_user_roles' + examples: + fetch: + value: + roles: + - wfo.full_access + url: https://flex-api.twilio.com/v1/Insights/UserRoles description: OK security: - accountSid_authToken: [] operationId: FetchInsightsUserRoles - x-maturity: - - Preview /v1/Interactions/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance dependentProperties: interaction_channel: '{interaction_sid: sid}' mountName: interaction + pathType: instance get: description: '' parameters: @@ -3063,23 +4342,38 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction' + examples: + fetch: + value: + sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel: + type: sms + sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + properties: + workflow_sid: WWxx + attributes: WWxx + task_channel_unique_name: sms + routing_target: WKXX + queue_name: WQXX + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels description: OK security: - accountSid_authToken: [] operationId: FetchInteraction - x-maturity: - - GA /v1/Interactions: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list dependentProperties: interaction_channel: '{interaction_sid: sid}' mountName: interaction + pathType: list post: description: Create a new Interaction. responses: @@ -3088,12 +4382,47 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction' + examples: + create: + value: + sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel: + type: sms + sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + date_updated: 1634845217 + task_queue_entered_date: 1634845217 + workflow_name: Default Fifo Workflow + age_in_queue: 0 + task_channel_unique_name: default + assignment_status: pending + queue_name: Sample Queue + assignmentCounter: 0 + priority: 0 + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reason: '' + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"initiated_by":"customer","conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","initiatedBy":"customer","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","direction":"inbound"}' + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 0 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout: 86400 + date_created: 1634845217 + addons: '{}' + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels description: Created security: - accountSid_authToken: [] operationId: CreateInteraction - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3108,14 +4437,18 @@ paths: required: - Channel - Routing + examples: + create: + value: + Channel: '{"type":"sms","initiated_by":"customer"}' + Routing: '{}' /v1/Interactions/{InteractionSid}/Channels/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance dependentProperties: interaction_channel_invite: '{interaction_sid: interaction_sid, channel_sid: sid}' @@ -3123,6 +4456,7 @@ paths: sid}' parent: /Interactions/{Sid} className: interaction_channel + pathType: instance get: description: Fetch a Channel for an Interaction. parameters: @@ -3152,12 +4486,23 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' + examples: + fetch: + value: + sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + type: chat + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: closed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites description: OK security: - accountSid_authToken: [] operationId: FetchInteractionChannel - x-maturity: - - GA post: description: Update an existing Interaction Channel. parameters: @@ -3187,12 +4532,35 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' + examples: + update: + value: + sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: chat + status: closed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites + updateStatusClosed: + value: + sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: chat + status: failed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites description: OK security: - accountSid_authToken: [] operationId: UpdateInteractionChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3212,14 +4580,20 @@ paths: all tasks will be set to `wrapping`. required: - Status + examples: + update: + value: + Status: closed + updateStatusClosed: + value: + Status: closed /v1/Interactions/{InteractionSid}/Channels: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list dependentProperties: interaction_channel_invite: '{interaction_sid: interaction_sid, channel_sid: sid}' @@ -3227,6 +4601,7 @@ paths: sid}' parent: /Interactions/{Sid} className: interaction_channel + pathType: list get: description: List all Channels for an Interaction. parameters: @@ -3272,44 +4647,104 @@ paths: items: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + channels: + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + type: chat + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: closed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + type: sms + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: active + error_code: null + error_message: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3 + type: email + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4 + type: voice + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: setup + error_code: null + error_message: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Invites + - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5 + type: gbm + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + error_code: 19025 + error_message: Channel validation error + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5 + links: + participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Participants + invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Invites + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListInteractionChannel - x-maturity: - - GA /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_channel_invite + pathType: list post: description: Invite an Agent or a TaskQueue to a Channel. parameters: @@ -3337,12 +4772,44 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' + examples: + create: + value: + sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: 1634845217 + date_updated: 1634845217 + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + assignment_status: pending + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_name: Default Fifo Workflow + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_name: Sample Queue + priority: 0 + age: 0 + reason: '' + timeout: 86400 + assignmentCounter: 0 + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_entered_date: 1634845217 + age_in_queue: 0 + addons: '{}' + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInteractionChannelInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3354,6 +4821,11 @@ paths: description: The Interaction's routing logic. required: - Routing + examples: + create: + value: + Routing: '{"properties":{"workspace_sid":"WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","workflow_sid":"WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","worker_sid":"WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","queue_sid":"WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","attributes":{"customerName":"customer + name","customerAddress":"customer email address"}}}' get: description: List all Invites for a Channel. parameters: @@ -3407,44 +4879,116 @@ paths: items: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + invites: + - sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: 1634845217 + date_updated: 1634845217 + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + assignment_status: pending + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_name: Default Fifo Workflow + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_name: Sample Queue + priority: 0 + age: 0 + reason: '' + timeout: 86400 + assignmentCounter: 0 + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_entered_date: 1634845217 + age_in_queue: 0 + addons: '{}' + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + - sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + routing: + reservation: null + properties: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: 1634845217 + date_updated: 1634845217 + attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer + phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer + name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' + assignment_status: pending + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_name: Default Fifo Workflow + queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + queue_name: Sample Queue + priority: 0 + age: 0 + reason: '' + timeout: 86400 + assignmentCounter: 0 + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_entered_date: 1634845217 + age_in_queue: 0 + addons: '{}' + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0 + next_page_url: null + key: invites description: OK security: - accountSid_authToken: [] operationId: ListInteractionChannelInvite - x-maturity: - - GA /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_channel_participant + pathType: list post: description: Add a Participant to a Channel. parameters: @@ -3472,12 +5016,18 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' + examples: + create: + value: + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 description: Created security: - accountSid_authToken: [] operationId: CreateInteractionChannelParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3496,6 +5046,12 @@ paths: required: - Type - MediaProperties + examples: + create: + value: + Type: customer + MediaProperties: '{"level": "to", "name": "Random Person test", + "address":"random@person.com", "type": "email"}' get: description: List all Participants for a Channel. parameters: @@ -3549,44 +5105,64 @@ paths: items: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + participants: + - sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + - sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: agent + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants description: OK security: - accountSid_authToken: [] operationId: ListInteractionChannelParticipant - x-maturity: - - GA /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_channel_participant + pathType: instance post: description: Update an existing Channel Participant. parameters: @@ -3624,12 +5200,25 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' + examples: + update: + value: + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: agent + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + updateStatusClosed: + value: + sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 + interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: agent + url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 description: OK security: - accountSid_authToken: [] operationId: UpdateInteractionChannelParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3644,16 +5233,23 @@ paths: must be an agent.' required: - Status + examples: + update: + value: + Status: closed + updateStatusClosed: + value: + Status: closed /v1/WebChannels: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - flex_flow_sid - pathType: list mountName: web_channel + pathType: list get: description: '' parameters: @@ -3689,34 +5285,61 @@ paths: items: $ref: '#/components/schemas/flex.v1.web_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: + - flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + previous_page_url: null + url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 + next_page_url: null + key: flex_chat_channels + flex_chat_channels: [] description: OK security: - accountSid_authToken: [] operationId: ListWebChannel - x-maturity: - - GA post: description: '' responses: @@ -3725,12 +5348,19 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' + examples: + create: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateWebChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3764,16 +5394,24 @@ paths: - Identity - CustomerFriendlyName - ChatFriendlyName + examples: + create: + value: + FlexFlowSid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Identity: abc + ChatFriendlyName: firendly1 + CustomerFriendlyName: friendly2 + PreEngagementData: '{}' /v1/WebChannels/{Sid}: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - flex_flow_sid - pathType: instance mountName: web_channel + pathType: instance get: description: '' parameters: @@ -3792,12 +5430,19 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' + examples: + fetch: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWebChannel - x-maturity: - - GA post: description: '' parameters: @@ -3816,12 +5461,19 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' + examples: + update: + value: + flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWebChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3836,6 +5488,11 @@ paths: PostEngagementData: type: string description: The post-engagement data. + examples: + update: + value: + ChatStatus: inactive + PostEngagementData: '{}' delete: description: '' parameters: @@ -3854,14 +5511,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWebChannel - x-maturity: - - GA servers: - url: https://flex-api.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index 7dd30ff3..fb4f25e4 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -1,5 +1,24 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + conductor_flow_enum_flow_type: + type: string + enum: + - StartInboundMessaging + - StartOutboundVoice + - AcceptInvite + - EndInboundMessaging + - EndOutboundVoice + conductor_flow_enum_name: + type: string + enum: + - AcceptInviteFlow + - EndInboundMessagingFlow + - StartInboundMessagingFlow + - StartOutboundVoiceFlow flex.v2.web_channel: type: object properties: @@ -17,10 +36,6 @@ components: description: The unique string representing the User created and should be authorized to participate in the Conversation. For more details, see [User Identity & Access Tokens](https://www.twilio.com/docs/conversations/identity). - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Flex description: This is the public Twilio REST API. @@ -32,19 +47,19 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/WebChats: servers: - url: https://flex-api.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conversation_sid - pathType: list mountName: web_channels className: web_channels + pathType: list post: description: '' responses: @@ -53,12 +68,15 @@ paths: application/json: schema: $ref: '#/components/schemas/flex.v2.web_channel' + examples: + create: + value: + conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: seinfeld description: Created security: - accountSid_authToken: [] operationId: CreateWebChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -88,8 +106,11 @@ paths: description: The pre-engagement data. required: - AddressSid + examples: + create: + value: + AddressSid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChatFriendlyName: LoquaciousLarry + CustomerFriendlyName: LarryDavid servers: - url: https://flex-api.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index deda0756..371daa5a 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: frontline.v1.user: type: object @@ -45,10 +49,6 @@ components: enum: - active - deactivated - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Frontline description: This is the public Twilio REST API. @@ -60,7 +60,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Users/{Sid}: @@ -88,12 +88,20 @@ paths: application/json: schema: $ref: '#/components/schemas/frontline.v1.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: john@example.com + friendly_name: John Doe + avatar: https://example.com/profile.png + state: active + is_available: true + url: https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - Beta post: description: Update an existing frontline user parameters: @@ -110,12 +118,20 @@ paths: application/json: schema: $ref: '#/components/schemas/frontline.v1.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: john@example.com + friendly_name: John Doe + avatar: https://example.com/profile.png + state: active + is_available: true + url: https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -139,9 +155,12 @@ paths: description: Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing). + examples: + update: + value: + State: active + FriendlyName: Name + Avatar: https://example.com/avatar.png + IsAvailable: true servers: - url: https://frontline-api.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 5505125e..735ce42a 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: insights.v1.account_settings: type: object @@ -9,16 +13,21 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. advanced_features: type: boolean nullable: true + description: A boolean flag indicating whether Advanced Features for Voice + Insights are enabled. voice_trace: type: boolean nullable: true + description: A boolean flag indicating whether Voice Trace is enabled. url: type: string format: uri nullable: true + description: The URL of this resource. insights.v1.call.annotation: type: object properties: @@ -40,53 +49,49 @@ components: type: string $ref: '#/components/schemas/annotation_enum_answered_by' nullable: true - description: 'Which entity answered the call as determined by Answering - Machine Detection. Use this to provide feedback on Answering Machine Detection - accuracy. Possible enumerated values, one of: human, machine. human indicates - the call was answered by a person. machine indicates the call was answered - by an answering machine.' + description: 'Specifies which entity answered the call as determined by + Answering Machine Detection. Possible enumerated values, one of: `human`, + `machine`. `human` indicates the call was answered by a person. `machine` + indicates the call was answered by an answering machine.' connectivity_issue: type: string $ref: '#/components/schemas/annotation_enum_connectivity_issue' nullable: true - description: 'Specify if the call had any connectivity issues. Possible - enumerated values, one : no_connectivity_issue, invalid_number, caller_id, - dropped_call, number_reachability.' + description: Specifies if the call had any connectivity issues. One of `no_connectivity_issue`, + `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. quality_issues: type: array items: type: string nullable: true - description: 'Specify if the call had any subjective quality issues. Possible - values, one or more of: no_quality_issue, low_volume, choppy_robotic, - echo, dtmf, latency, owa, static_noise. Use comma separated values to - indicate multiple quality issues for the same call' + description: Specifies if the call had any subjective quality issues. Possible + values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, + `echo`, `dtmf`, `latency`, `owa`, or `static_noise`. spam: type: boolean nullable: true - description: 'Specify if the call was a spam call. Use this to provide feedback - on whether calls placed from your account were marked as spam, or if inbound - calls received by your account were unwanted spam. Is of type Boolean: - true, false. Use true if the call was a spam call.' + description: 'Specifies if the call was a spam call. Use this to provide + feedback on whether calls placed from your account were marked as spam, + or if inbound calls received by your account were unwanted spam. Is of + type Boolean: true, false. Use true if the call was a spam call.' call_score: type: integer nullable: true - description: 'Specify the call score. This is of type integer. Use a range - of 1-5 to indicate the call experience score, with the following mapping - as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 - : Poor, 1: Bad].' + description: 'Specifies the Call Score, if available. This is of type integer. + Use a range of 1-5 to indicate the call experience score, with the following + mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : + Fair, 2 : Poor, 1: Bad].' comment: type: string nullable: true - description: "Specify any comments pertaining to the call. This of type\ - \ string with a max limit of 100 characters. Twilio does not treat this\ - \ field as PII, so don\u2019t put any PII in here." + description: Specifies any comments pertaining to the call. Twilio does + not treat this field as PII, so no PII should be included in comments. incident: type: string nullable: true - description: "Associate this call with an incident or support ticket. This\ - \ is of type string with a max limit of 100 characters. Twilio does not\ - \ treat this field as PII, so don\u2019t put any PII in here." + description: Incident or support ticket associated with this call. The `incident` + property is of type string with a maximum character limit of 100. Twilio + does not treat this field as PII, so no PII should be included in `incident`. url: type: string format: uri @@ -145,73 +150,114 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. answered_by: type: string $ref: '#/components/schemas/call_summaries_enum_answered_by' nullable: true + description: The Answered By value for the summarized call based on `Answering + Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, + `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to + [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for + more detail. call_type: type: string $ref: '#/components/schemas/call_summaries_enum_call_type' nullable: true + description: The Call Type of the summarized Call. One of `carrier`, `sip`, + `trunking` or `client`. call_state: type: string $ref: '#/components/schemas/call_summaries_enum_call_state' nullable: true + description: The Call State of the summarized Call. One of `ringing`, `completed`, + `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`. processing_state: type: string $ref: '#/components/schemas/call_summaries_enum_processing_state' nullable: true + description: The Processing State of the Call Summary. The Processing State + will be `partial` until the assembly of the Call Summary finishes, which + occurs approximately 30 minutes after Call end. Then the Processing State + changes to `complete` created_time: type: string format: date-time nullable: true + description: The time at which the Call was created, given in ISO 8601 format. + Can be different from `start_time` in the event of queueing due to CPS start_time: type: string format: date-time nullable: true + description: The time at which the Call was started, given in ISO 8601 format. end_time: type: string format: date-time nullable: true + description: The time at which the Call was ended, given in ISO 8601 format. duration: type: integer nullable: true + description: Duration between when the call was initiated and the call was + ended connect_duration: type: integer nullable: true + description: Duration between when the call was answered and when it ended from: nullable: true + description: The calling party. to: nullable: true + description: The called party. carrier_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a PSTN call. client_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a Client call. sdk_edge: nullable: true + description: Contains metrics and properties for the SDK sensor library + for Client calls. sip_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a SIP Interface or Trunking call. tags: type: array items: type: string nullable: true + description: Tags applied to calls by Voice Insights analysis indicating + a condition that could result in subjective degradation of the call quality. url: type: string format: uri nullable: true + description: The URL of this resource. attributes: nullable: true + description: Attributes capturing call-flow-specific details. properties: nullable: true + description: Contains edge-agnostic call-level details. trust: nullable: true + description: Contains trusted communications details including Branded Call + and verified caller ID. + annotation: + nullable: true call_summaries_enum_answered_by: type: string enum: @@ -632,40 +678,62 @@ components: timestamp: type: string nullable: true + description: Event time. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. edge: type: string $ref: '#/components/schemas/event_enum_twilio_edge' nullable: true + description: The Edge of this Event. One of `unknown_edge`, `carrier_edge`, + `sip_edge`, `sdk_edge` or `client_edge`. group: type: string nullable: true + description: Event group. level: type: string $ref: '#/components/schemas/event_enum_level' nullable: true + description: The Level of this Event. One of `UNKNOWN`, `DEBUG`, `INFO`, + `WARNING` or `ERROR`. name: type: string nullable: true + description: Event name. carrier_edge: nullable: true + description: Represents the connection between Twilio and our immediate + carrier partners. The events here describe the call lifecycle as reported + by Twilio's carrier media gateways. sip_edge: nullable: true + description: Represents the Twilio media gateway for SIP interface and SIP + trunking calls. The events here describe the call lifecycle as reported + by Twilio's public media gateways. sdk_edge: nullable: true + description: Represents the Voice SDK running locally in the browser or + in the Android/iOS application. The events here are emitted by the Voice + SDK in response to certain call progress events, network changes, or call + quality conditions. client_edge: nullable: true + description: Represents the Twilio media gateway for Client calls. The events + here describe the call lifecycle as reported by Twilio's Voice SDK media + gateways. event_enum_twilio_edge: type: string enum: @@ -688,34 +756,50 @@ components: timestamp: type: string nullable: true + description: Timestamp of metric sample. Samples are taken every 10 seconds + and contain the metrics for the previous 10 seconds. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. edge: type: string $ref: '#/components/schemas/metric_enum_twilio_edge' nullable: true + description: The Twilio media edge this Metric was captured on. One of `unknown_edge`, + `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. direction: type: string $ref: '#/components/schemas/metric_enum_stream_direction' nullable: true + description: The Direction of the media stream from the perspective of the + Twilio media edge. One of `unknown`, `inbound`, `outbound` or `both`. carrier_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a PSTN call. sip_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a SIP Interface or Trunking call. sdk_edge: nullable: true + description: Contains metrics and properties for the SDK sensor library + for Client calls. client_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a Client call. metric_enum_twilio_edge: type: string enum: @@ -740,75 +824,118 @@ components: maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Account. call_sid: type: string minLength: 34 maxLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ nullable: true + description: The unique SID identifier of the Call. call_type: type: string $ref: '#/components/schemas/summary_enum_call_type' nullable: true + description: The Call Type of the summarized Call. One of `carrier`, `sip`, + `trunking` or `client`. call_state: type: string $ref: '#/components/schemas/summary_enum_call_state' nullable: true + description: The Call State of the summarized Call. One of `ringing`, `completed`, + `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`. answered_by: type: string $ref: '#/components/schemas/summary_enum_answered_by' nullable: true + description: The Answered By value for the summarized call based on `Answering + Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, + `machine_end_silence`, `machine_end_other`, `human` or `fax`. Refer to + [AMD](https://www.twilio.com/docs/voice/answering-machine-detection) for + more detail. processing_state: type: string $ref: '#/components/schemas/summary_enum_processing_state' nullable: true + description: The Processing State of the Call Summary. The Processing State + will be `partial` until the assembly of the Call Summary finishes, which + occurs approximately 30 minutes after Call end. Then the Processing State + changes to `complete` created_time: type: string format: date-time nullable: true + description: The time at which the Call was created, given in ISO 8601 format. + Can be different from `start_time` in the event of queueing due to CPS start_time: type: string format: date-time nullable: true + description: The time at which the Call was started, given in ISO 8601 format. end_time: type: string format: date-time nullable: true + description: The time at which the Call was ended, given in ISO 8601 format. duration: type: integer nullable: true + description: Duration between when the call was initiated and the call was + ended connect_duration: type: integer nullable: true + description: Duration between when the call was answered and when it ended from: nullable: true + description: The calling party. to: nullable: true + description: The called party. carrier_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a PSTN call. client_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a Client call. sdk_edge: nullable: true + description: Contains metrics and properties for the SDK sensor library + for Client calls. sip_edge: nullable: true + description: Contains metrics and properties for the Twilio media gateway + of a SIP Interface or Trunking call. tags: type: array items: type: string nullable: true + description: Tags applied to calls by Voice Insights analysis indicating + a condition that could result in subjective degradation of the call quality. url: type: string format: uri nullable: true + description: The URL of this resource. attributes: nullable: true + description: Attributes capturing call-flow-specific details. properties: nullable: true + description: Contains edge-agnostic call-level details. trust: nullable: true + description: Contains trusted communications details including Branded Call + and verified caller ID. annotation: nullable: true + description: Programmatically labeled annotations for the Call. Developers + can update the Call Summary records with Annotation during or after a + Call. Annotations can be updated as long as the Call Summary record is + addressable via the API. summary_enum_answered_by: type: string enum: @@ -1184,10 +1311,6 @@ components: - roaming - umatilla - tokyo - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Insights description: This is the public Twilio REST API. @@ -1199,24 +1322,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Voice/Settings: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - advanced_features - voice_trace pathType: instance get: - description: '' + description: Get the Voice Insights Settings. parameters: - name: SubaccountSid in: query - description: '' + description: The unique SID identifier of the Subaccount. schema: type: string minLength: 34 @@ -1228,26 +1351,36 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.account_settings' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_trace: true + advanced_features: true + url: https://insights.twilio.com/v1/Voice/Settings description: OK security: - accountSid_authToken: [] operationId: FetchAccountSettings - x-maturity: - - GA post: - description: '' + description: Update a specific Voice Insights Setting. responses: '200': content: application/json: schema: $ref: '#/components/schemas/insights.v1.account_settings' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + voice_trace: true + advanced_features: true + url: https://insights.twilio.com/v1/Voice/Settings description: OK security: - accountSid_authToken: [] operationId: UpdateAccountSettings - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1257,28 +1390,35 @@ paths: properties: AdvancedFeatures: type: boolean - description: '' + description: A boolean flag to enable Advanced Features for Voice + Insights. VoiceTrace: type: boolean - description: '' + description: A boolean flag to enable Voice Trace. SubaccountSid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ - description: '' + description: The unique SID identifier of the Subaccount. + examples: + update: + value: + VoiceTrace: true + AdvancedFeatures: true + SubaccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab /v1/Voice/{CallSid}/Annotation: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - call_sid - account_sid - pathType: instance parent: /Voice/{Sid} + pathType: instance post: - description: Create/Update the annotation for the call + description: Update an Annotation for a specific Call. parameters: - name: CallSid in: path @@ -1296,12 +1436,25 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call.annotation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answered_by: human + connectivity_issue: invalid_number + quality_issues: + - low_volume + - choppy_robotic + spam: true + call_score: 2 + comment: this is a call + incident: https://twilio.zendesk.com/support/tickets/17353089 + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation description: OK security: - accountSid_authToken: [] operationId: UpdateAnnotation - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1312,31 +1465,32 @@ paths: AnsweredBy: type: string $ref: '#/components/schemas/annotation_enum_answered_by' - description: 'Which entity answered the call as determined by Answering - Machine Detection. Use this to provide feedback on Answering Machine - Detection accuracy. Possible enumerated values, one of: human, - machine. human indicates the call was answered by a person. machine - indicates the call was answered by an answering machine.' + description: 'Specify which entity answered the call as determined + by Answering Machine Detection. Use this to provide feedback on + Answering Machine Detection accuracy. Possible enumerated values, + one of: `human`, `machine`. `human` indicates the call was answered + by a person. `machine` indicates the call was answered by an answering + machine.' ConnectivityIssue: type: string $ref: '#/components/schemas/annotation_enum_connectivity_issue' - description: 'Specify if the call had any connectivity issues. Possible - enumerated values, one : no_connectivity_issue, invalid_number, - caller_id, dropped_call, number_reachability.' + description: Specify if the call had any connectivity issues. Possible + enumerated values, one of `no_connectivity_issue`, `invalid_number`, + `caller_id`, `dropped_call`, or `number_reachability`. QualityIssues: type: string - description: 'Specify if the call had any subjective quality issues. - Possible values, one or more of: no_quality_issue, low_volume, - choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma - separated values to indicate multiple quality issues for the same - call' + description: Specify if the call had any subjective quality issues. + Possible values, one or more of `no_quality_issue`, `low_volume`, + `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. + Use comma separated values to indicate multiple quality issues + for the same call. Spam: type: boolean - description: 'Specify if the call was a spam call. Use this to provide - feedback on whether calls placed from your account were marked - as spam, or if inbound calls received by your account were unwanted - spam. Is of type Boolean: true, false. Use true if the call was - a spam call.' + description: A boolean flag to indicate if the call was a spam call. + Use this to provide feedback on whether calls placed from your + account were marked as spam, or if inbound calls received by your + account were unwanted spam. Use `true` if the call was a spam + call. CallScore: type: integer nullable: true @@ -1346,17 +1500,27 @@ paths: 4: Good, 3 : Fair, 2 : Poor, 1: Bad].' Comment: type: string - description: "Specify any comments pertaining to the call. This\ - \ of type string with a max limit of 100 characters. Twilio does\ - \ not treat this field as PII, so don\u2019t put any PII in here." + description: Specify any comments pertaining to the call. `comment` + has a maximum character limit of 100. Twilio does not treat this + field as PII, so no PII should be included in the `comment`. Incident: type: string - description: "Associate this call with an incident or support ticket.\ - \ This is of type string with a max limit of 100 characters. Twilio\ - \ does not treat this field as PII, so don\u2019t put any PII\ - \ in here." + description: Associate this call with an incident or support ticket. + The `incident` parameter is of type string with a maximum character + limit of 100. Twilio does not treat this field as PII, so no PII + should be included in `incident`. + examples: + update: + value: + AnsweredBy: human + ConnectivityIssue: invalid_number + QualityIssues: low_volume,choppy_robotic + Spam: true + CallScore: 2 + Comment: this is a call + Incident: https://twilio.zendesk.com/support/tickets/17353089 get: - description: Fetch a specific Annotation. + description: Get the Annotation for a specific Call. parameters: - name: CallSid in: path @@ -1373,25 +1537,37 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call.annotation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answered_by: human + connectivity_issue: invalid_number + quality_issues: + - low_volume + spam: true + call_score: 2 + comment: this is a call + incident: https://twilio.zendesk.com/support/tickets/17353089 + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation description: OK security: - accountSid_authToken: [] operationId: FetchAnnotation - x-maturity: - - Beta /v1/Voice/{Sid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: event: '{call_sid: sid}' metric: '{call_sid: sid}' call_summary: '{call_sid: sid}' annotation: '{call_sid: sid}' mountName: calls + pathType: instance get: description: '' parameters: @@ -1410,16 +1586,24 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call' + examples: + fetch: + value: + sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + events: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + metrics: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics + summary: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary + annotation: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Annotation description: OK security: - accountSid_authToken: [] operationId: FetchCall - x-maturity: - - GA /v1/Voice/Summaries: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid @@ -1431,133 +1615,202 @@ paths: - connect_duration - call_type - call_state - pathType: list mountName: call_summaries className: call_summaries + pathType: list get: - description: '' + description: Get a list of Call Summaries. parameters: - name: From in: query - description: '' + description: A calling party. Could be an E.164 number, a SIP URI, or a Twilio + Client registered name. schema: type: string - name: To in: query - description: '' + description: A called party. Could be an E.164 number, a SIP URI, or a Twilio + Client registered name. schema: type: string - name: FromCarrier in: query - description: '' + description: An origination carrier. schema: type: string - name: ToCarrier in: query - description: '' + description: A destination carrier. schema: type: string + examples: + readWithCarrier: + value: AT&T Wireless - name: FromCountryCode in: query - description: '' + description: A source country code based on phone number in From. schema: type: string - name: ToCountryCode in: query - description: '' + description: A destination country code. Based on phone number in To. schema: type: string - name: Branded in: query - description: '' + description: A boolean flag indicating whether or not the calls were branded + using Twilio Branded Calls. schema: type: boolean - name: VerifiedCaller in: query - description: '' + description: A boolean flag indicating whether or not the caller was verified + using SHAKEN/STIR. schema: type: boolean + examples: + readWithTrust: + value: true - name: HasTag in: query - description: '' + description: A boolean flag indicating the presence of one or more [Voice + Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags). schema: type: boolean + examples: + readWithSubaccount: + value: true - name: StartTime in: query - description: '' + description: A Start time of the calls. xm (x minutes), xh (x hours), xd (x + days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h. schema: type: string + examples: + readWithCarrier: + value: 4h + readWithSubaccount: + value: 7d + readWithTrust: + value: 1d + readWithAbnormalSession: + value: 15d - name: EndTime in: query - description: '' + description: An End Time of the calls. xm (x minutes), xh (x hours), xd (x + days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m. schema: type: string - name: CallType in: query - description: '' + description: A Call Type of the calls. One of `carrier`, `sip`, `trunking` + or `client`. schema: type: string + examples: + readWithSubaccount: + value: client + readWithAbnormalSession: + value: sip,trunking - name: CallState in: query - description: '' + description: A Call State of the calls. One of `ringing`, `completed`, `busy`, + `fail`, `noanswer`, `canceled`, `answered`, `undialed`. schema: type: string + examples: + readWithAbnormalSession: + value: completed - name: Direction in: query - description: '' + description: A Direction of the calls. One of `outbound_api`, `outbound_dial`, + `inbound`, `trunking_originating`, `trunking_terminating`. schema: type: string + examples: + readWithTrust: + value: outbound_api,outbound_dial,trunking_terminating - name: ProcessingState in: query - description: '' + description: A Processing State of the Call Summaries. One of `completed`, + `partial` or `all`. schema: type: string $ref: '#/components/schemas/call_summaries_enum_processing_state_request' - name: SortBy in: query - description: '' + description: A Sort By criterion for the returned list of Call Summaries. + One of `start_time` or `end_time`. schema: type: string $ref: '#/components/schemas/call_summaries_enum_sort_by' - name: Subaccount in: query - description: '' + description: A unique SID identifier of a Subaccount. schema: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ + examples: + readWithSubaccount: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - name: AbnormalSession in: query - description: '' + description: A boolean flag indicating an abnormal session where the last + SIP response was not 200 OK. schema: type: boolean + examples: + readWithAbnormalSession: + value: true - name: AnsweredBy in: query - description: '' + description: An Answered By value for the calls based on `Answering Machine + Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, + `machine_end_silence`, `machine_end_other`, `human` or `fax`. schema: type: string $ref: '#/components/schemas/call_summaries_enum_answered_by' - - name: ConnectivityIssues + examples: + readWithCarrier: + value: machine_start + - name: ConnectivityIssue in: query - description: '' + description: A Connectivity Issue with the calls. One of `no_connectivity_issue`, + `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`. schema: type: string - - name: QualityIssues + examples: + readWithAnnotationParameters: + value: invalid_number,dropped_call + - name: QualityIssue in: query - description: '' + description: A subjective Quality Issue with the calls. One of `no_quality_issue`, + `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. schema: type: string + examples: + readWithAnnotationParameters: + value: choppy_robotic,echo - name: Spam in: query - description: '' + description: A boolean flag indicating spam calls. schema: type: boolean - - name: CallScores + examples: + readWithAnnotationParameters: + value: true + - name: CallScore in: query - description: '' + description: 'A Call Score of the calls. Use a range of 1-5 to indicate the + call experience score, with the following mapping as a reference for the + rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].' schema: type: string + examples: + readWithAnnotationParameters: + value: 1,2 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1590,47 +1843,872 @@ paths: items: $ref: '#/components/schemas/insights.v1.call_summaries' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?PageSize=25&Page=0 + call_summaries: [] + readWithCarrier: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?ToCarrier=AT%26T+Wireless&AnsweredBy=machine_start&StartTime=4h&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T03:40:25Z' + start_time: '2021-08-25T03:40:25Z' + end_time: '2021-08-25T03:40:45Z' + duration: 20 + connect_duration: 20 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: '+15555555556' + carrier: AT&T Wireless + connection: mobile + number_prefix: '1555' + location: + lat: 33.42767 + lon: -86.886475 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxxx + direction: inbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 202 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.48209 + avg: 0.483035 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 218 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.51868 + avg: 0.364434 + tags: + - high_packet_loss + - high_jitter + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 121 + disconnected_by: callee + direction: inbound + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T02:20:25Z' + start_time: '2021-08-25T02:20:25Z' + end_time: '2021-08-25T02:40:45Z' + duration: 18 + connect_duration: 18 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: '+15555555556' + carrier: AT&T Wireless + connection: mobile + number_prefix: '1555' + location: + lat: 33.42767 + lon: -86.886475 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxxx + direction: inbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 100 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.48209 + avg: 0.483035 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 102 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.51868 + avg: 0.364434 + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 121 + disconnected_by: callee + direction: inbound + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithSubaccount: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?CallType=client&StartTime=7d&HasTag=True&Subaccount=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + created_time: '2021-08-25T04:16:35Z' + start_time: '2021-08-25T04:16:36Z' + end_time: '2021-08-25T04:16:42Z' + duration: 7 + connect_duration: 6 + call_type: client + call_state: completed + answered_by: machine_start + from: + caller: client:+15555555555 + connection: twilio_sdk + to: + callee: client:TBBXXXXXXXXXXXX + connection: twilio_sdk + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xxx + external_media_ip: 54.xxx.xx.xxx + edge_location: xxxxxx + direction: inbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 252 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 5.60994 + avg: 0.933334 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 229 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.960786 + avg: 0.399859 + carrier_edge: null + tags: + - high_pdd + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 58 + disconnected_by: callee + direction: inbound + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + created_time: '2021-08-25T04:16:35Z' + start_time: '2021-08-25T04:16:37Z' + end_time: '2021-08-25T04:16:40Z' + duration: 5 + connect_duration: 3 + call_type: client + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: Verizon + connection: landline + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: client:TBBTXXXXXX + connection: twilio_sdk + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xxx + external_media_ip: 54.xxx.xx.xxx + edge_location: xxxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 110 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.05918 + avg: 0.461966 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 147 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.869174 + avg: 0.319674 + carrier_edge: null + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 35 + disconnected_by: callee + direction: outbound_api + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithTrust: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?Direction=outbound_api%2Coutbound_dial%2Ctrunking_terminating&StartTime=1d&VerifiedCaller=True&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:31:18Z' + start_time: '2021-08-25T14:31:22Z' + end_time: '2021-08-25T14:32:02Z' + duration: 44 + connect_duration: 41 + call_type: trunking + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: ACS + connection: landline + number_prefix: '1555' + location: + lat: 60.268353 + lon: -141.13632 + country_code: US + to: + callee: '+15555555556' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xx + twilio_signaling_ip: 54.xxx.xx.xx + external_signaling_ip: 54.xxx.xx.xx + sip_call_id: xxxxx@0.0.0.0 + user_agent: xxxx + edge_location: xxxxx + trunk_sid: xxxxxxx + direction: inbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 1953 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.76407 + avg: 0.23138 + latency: + max: 0.386 + avg: 0.3765 + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + tags: + - silence + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 1990 + disconnected_by: caller + direction: trunking_terminating + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:03:31Z' + start_time: '2021-08-25T14:03:32Z' + end_time: '2021-08-25T14:03:38Z' + duration: 7 + connect_duration: 6 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: '+15555555556' + carrier: T-Mobile USA, Inc. + connection: mobile + number_prefix: '1555' + location: + lat: 34.186115 + lon: -118.43555 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 229 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.10303 + avg: 0.449886 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 273 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.410031 + avg: 0.295951 + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 315 + disconnected_by: callee + direction: outbound_api + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-24T22:28:17Z' + start_time: '2021-08-24T22:28:20Z' + end_time: '2021-08-24T22:28:23Z' + duration: 4 + connect_duration: 3 + call_type: carrier + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + to: + callee: '+15555555556' + connection: pstn + processing_state: complete + sdk_edge: null + sip_edge: null + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 103 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.596712 + avg: 0.251725 + tags: + - silence + attributes: null + properties: + last_sip_response_num: 200 + pdd_ms: 105 + disconnected_by: caller + direction: outbound_dial + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithAbnormalSession: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?CallType=sip%2Ctrunking&CallState=completed&StartTime=15d&AbnormalSession=True&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:46:40Z' + start_time: '2021-08-25T14:46:40Z' + end_time: '2021-08-25T14:46:52Z' + duration: 12 + connect_duration: 12 + call_type: sip + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: XO Communications, Inc. + connection: landline + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: sip:xxxx@xx.xxx.xx.xxx + connection: sip_interface + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: xx.xxx.xx.xxx + twilio_signaling_ip: xx.xx.xx.xx + external_media_ip: xx.xxx.xx.xxx + external_signaling_ip: xx.xxx.xx.xxx + sip_call_id: xxxxxxxx@0.0.0.0 + edge_location: xxxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 525 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.554729 + avg: 0.229541 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 245 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.03548 + avg: 0.344092 + client_edge: null + carrier_edge: null + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 255 + disconnected_by: callee + direction: outbound_dial + trust: null + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:31:18Z' + start_time: '2021-08-25T14:31:22Z' + end_time: '2021-08-25T14:32:02Z' + duration: 44 + connect_duration: 41 + call_type: trunking + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: ACS + connection: landline + number_prefix: '1555' + location: + lat: 60.268353 + lon: -141.13632 + country_code: US + to: + callee: '+15555555556' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xx + twilio_signaling_ip: 54.xxx.xx.xx + external_signaling_ip: 54.xxx.xx.xx + sip_call_id: xxxxx@0.0.0.0 + user_agent: xxxx + edge_location: xxxxx + trunk_sid: xxxxxxx + direction: inbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 1953 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.76407 + avg: 0.23138 + latency: + max: 0.386 + avg: 0.3765 + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + tags: + - silence + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 1990 + disconnected_by: caller + direction: trunking_terminating + trust: + verified_caller: + verified: true + annotation: null + url: https://insights.twilio.com/v1/Voice/Summaries + readWithAnnotationParameters: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Voice/Summaries?QualityIssue=choppy_robotic%2Cecho&CallScore=1%2C2&ConnectivityIssue=invalid_number%2Cdropped_call&Spam=True&PageSize=25&Page=0 + previous_page_url: null + next_page_url: null + key: call_summaries + url: https://insights.twilio.com/v1/Voice/Summaries?QualityIssue=choppy_robotic%2Cecho&CallScore=1%2C2&ConnectivityIssue=invalid_number%2Cdropped_call&Spam=True&PageSize=25&Page=0 + call_summaries: + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:46:40Z' + start_time: '2021-08-25T14:46:40Z' + end_time: '2021-08-25T14:46:52Z' + duration: 12 + connect_duration: 12 + call_type: sip + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: XO Communications, Inc. + connection: landline + number_prefix: '1555' + location: + lat: 40.83885 + lon: -74.04568 + country_code: US + to: + callee: sip:xxxx@xx.xxx.xx.xxx + connection: sip_interface + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: xx.xxx.xx.xxx + twilio_signaling_ip: xx.xx.xx.xx + external_media_ip: xx.xxx.xx.xxx + external_signaling_ip: xx.xxx.xx.xxx + sip_call_id: xxxxxxxx@0.0.0.0 + edge_location: xxxxx + direction: outbound + metrics: + inbound: + codec: 0 + codec_name: pcmu + packets_received: 525 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 0.554729 + avg: 0.229541 + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 245 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.03548 + avg: 0.344092 + client_edge: null + carrier_edge: null + tags: null + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 255 + disconnected_by: callee + direction: outbound_dial + trust: null + annotation: + spam: true + connectivity_issue: invalid_number + quality_issues: + - choppy_robotic + call_score: 1 + url: https://insights.twilio.com/v1/Voice/Summaries + - call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_time: '2021-08-25T14:31:18Z' + start_time: '2021-08-25T14:31:22Z' + end_time: '2021-08-25T14:32:02Z' + duration: 44 + connect_duration: 41 + call_type: trunking + call_state: completed + answered_by: machine_start + from: + caller: '+15555555555' + carrier: ACS + connection: landline + number_prefix: '1555' + location: + lat: 60.268353 + lon: -141.13632 + country_code: US + to: + callee: '+15555555556' + carrier: Hawaiian Telcom, Inc. - HI + connection: landline + number_prefix: '1555' + location: + lat: 20.956036 + lon: -157.23793 + country_code: US + processing_state: complete + sdk_edge: null + sip_edge: + properties: + media_region: us1 + signaling_region: us1 + twilio_media_ip: 54.xxx.xx.xx + twilio_signaling_ip: 54.xxx.xx.xx + external_signaling_ip: 54.xxx.xx.xx + sip_call_id: xxxxx@0.0.0.0 + user_agent: xxxx + edge_location: xxxxx + trunk_sid: xxxxxxx + direction: inbound + metrics: + outbound: + codec: 0 + codec_name: pcmu + packets_sent: 1953 + packets_lost: 0 + packets_loss_percentage: 0.0 + jitter: + max: 1.76407 + avg: 0.23138 + latency: + max: 0.386 + avg: 0.3765 + client_edge: null + carrier_edge: + properties: + media_region: us1 + signaling_region: us1 + edge_location: xxxx + direction: outbound + tags: + - silence + attributes: + conference_participant: false + properties: + last_sip_response_num: 200 + pdd_ms: 1990 + disconnected_by: caller + direction: trunking_terminating + trust: + verified_caller: + verified: true + annotation: + spam: true + connectivity_issue: invalid_number + quality_issues: + - choppy_robotic + call_score: 1 + url: https://insights.twilio.com/v1/Voice/Summaries description: OK security: - accountSid_authToken: [] operationId: ListCallSummaries - x-maturity: - - GA /v1/Conferences/{ConferenceSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conference_sid - account_sid - pathType: instance dependentProperties: conference_participant: '{conference_sid: conference_sid}' + pathType: instance get: - description: Fetch a specific Conference. + description: Get a specific Conference Summary. parameters: - name: ConferenceSid in: path @@ -1647,25 +2725,61 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.conference' + examples: + fetch: + value: + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference1 + start_time: '2021-10-08T02:58:51Z' + create_time: '2021-10-08T02:58:47Z' + end_time: '2021-10-08T03:00:02Z' + duration_seconds: 76 + connect_duration_seconds: 72 + status: completed + max_participants: 250 + max_concurrent_participants: 4 + unique_participants: 4 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: us1 + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 1 + region_configuration: 0 + participant_behavior: 3 + tags: + - duplicate_identity + - detected_silence + - participant_behavior_issues + tag_info: + duplicate_identity: + - participant_identity: client:+10000000000 + participant_sids: + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: FetchConference - x-maturity: - - GA /v1/Conferences: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - conference_sid - account_sid - pathType: list dependentProperties: conference_participant: '{conference_sid: conference_sid}' + pathType: list get: - description: Retrieve a list of Conferences. + description: Get a list of Conference Summaries. parameters: - name: ConferenceSid in: query @@ -1677,34 +2791,54 @@ paths: description: Custom label for the conference resource, up to 64 characters. schema: type: string + examples: + readWithFriendlynameStartfailure: + value: outboundConfCallTransferThrice_1 - name: Status in: query description: Conference status. schema: type: string + examples: + readWithRegion: + value: completed + readWithFriendlynameStartfailure: + value: not_started - name: CreatedAfter in: query description: Conferences created after the provided timestamp specified in ISO 8601 format schema: type: string + examples: + readFull: + value: '2021-10-09T17:20:53Z' - name: CreatedBefore in: query description: Conferences created before the provided timestamp specified in ISO 8601 format. schema: type: string + examples: + readFull: + value: '2021-10-12T18:37:53Z' - name: MixerRegion in: query description: Twilio region where the conference media was mixed. schema: type: string + examples: + readWithRegion: + value: au1 - name: Tags in: query description: Tags applied by Twilio for common potential configuration, quality, or performance issues. schema: type: string + examples: + readWithDuplicateIdentity: + value: duplicate_identity - name: Subaccount in: query description: Account SID for the subaccount whose resources you wish to retrieve. @@ -1719,12 +2853,18 @@ paths: during the conference. schema: type: string + examples: + readWithDetectedIssueEndreason: + value: call_quality - name: EndReason in: query description: Conference end reason; e.g. last participant left, modified by API, etc. schema: type: string + examples: + readWithDetectedIssueEndreason: + value: participant_with_end_conference_on_exit_left - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1757,49 +2897,316 @@ paths: items: $ref: '#/components/schemas/insights.v1.conference' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?CreatedAfter=2021-10-09T17%3A20%3A53Z&CreatedBefore=2021-10-12T18%3A37%3A53Z&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-10-12T18:11:10Z' + create_time: '2021-10-12T18:11:09Z' + end_time: '2021-10-12T18:11:15Z' + duration_seconds: 7 + connect_duration_seconds: 5 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 2 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 1 + region_configuration: 0 + participant_behavior: 0 + tags: null + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 2 + start_time: null + create_time: '2021-10-12T18:09:21Z' + end_time: '2021-10-12T18:09:21Z' + duration_seconds: 1 + connect_duration_seconds: 0 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 3 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 1 + region_configuration: 0 + participant_behavior: 0 + tags: + - detected_silence + - participant_behavior_issues + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants + readWithRegion: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?MixerRegion=au1&Status=completed&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-10-12T18:19:10Z' + create_time: '2021-10-12T18:19:09Z' + end_time: '2021-10-12T18:20:17Z' + duration_seconds: 7 + connect_duration_seconds: 5 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 2 + end_reason: participant_with_end_conference_on_exit_kicked + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: au1 + mixer_region_requested: au1 + recording_enabled: true + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 2 + participant_behavior: 0 + tags: + - region_configuration_issues + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 2 + start_time: '2021-10-12T18:16:53Z' + create_time: '2021-10-12T18:16:51Z' + end_time: '2021-10-12T18:17:20Z' + duration_seconds: 30 + connect_duration_seconds: 27 + status: completed + max_participants: 250 + max_concurrent_participants: 2 + unique_participants: 2 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + mixer_region: au1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 2 + participant_behavior: 3 + tags: + - detected_silence + - region_configuration_issues + - participant_behavior_issues + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Participants + readWithFriendlynameStartfailure: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?FriendlyName=outboundConfCallTransferThrice_1&Status=not_started&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: outboundConfCallTransferThrice_1 + start_time: null + create_time: '2021-11-18T00:09:09Z' + end_time: '2021-11-18T00:09:52Z' + duration_seconds: 7 + connect_duration_seconds: 0 + status: not_started + max_participants: 250 + max_concurrent_participants: 1 + unique_participants: 1 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: null + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 0 + participant_behavior: 0 + tags: + - participant_behavior_issues + - start_failure + tag_info: + start_failure: + reason: no_concurrent_participants + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + readWithDuplicateIdentity: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?Tags=duplicate_identity&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-11-17T16:21:45Z' + create_time: '2021-11-17T16:21:40Z' + end_time: '2021-11-17T16:22:11Z' + duration_seconds: 32 + connect_duration_seconds: 27 + status: not_started + max_participants: 250 + max_concurrent_participants: 3 + unique_participants: 4 + end_reason: last_participant_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 0 + region_configuration: 0 + participant_behavior: 0 + tags: + - duplicate_identity + - detected_silence + - participant_behavior_issues + tag_info: + duplicate_identity: + - participant_identity: client:+10000000000 + participant_sids: + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + readWithDetectedIssueEndreason: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences?DetectedIssues=call_quality&EndReason=participant_with_end_conference_on_exit_left&PageSize=25&Page=0 + next_page_url: null + key: conferences + conferences: + - conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: conference 1 + start_time: '2021-11-17T16:21:45Z' + create_time: '2021-11-17T16:21:40Z' + end_time: '2021-11-17T16:22:11Z' + duration_seconds: 32 + connect_duration_seconds: 27 + status: not_started + max_participants: 250 + max_concurrent_participants: 3 + unique_participants: 3 + end_reason: participant_with_end_conference_on_exit_left + ended_by: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + mixer_region: us1 + mixer_region_requested: null + recording_enabled: false + processing_state: complete + detected_issues: + call_quality: 3 + region_configuration: 0 + participant_behavior: 1 + tags: + - high_packet_loss + - low_mos + - participant_behavior_issues + - quality_warnings + - high_jitter + - detected_silence + tag_info: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + conference_participants: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: ListConference - x-maturity: - - GA /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - conference_sid - call_sid - account_sid - pathType: instance parent: /Conferences/{ConferenceSid} mountName: conference_participants + pathType: instance get: - description: Fetch a specific Conference Participant Summary. + description: Get a specific Conference Participant Summary for a Conference. parameters: - name: ConferenceSid in: path @@ -1836,27 +3243,85 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.conference.conference_participant' + examples: + fetch: + value: + participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+1000000001' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:59Z' + leave_time: '2021-10-08T03:00:02Z' + duration_seconds: 64 + outbound_queue_length: 0 + outbound_time_in_queue: 965 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: false + end_conference_on_exit: false + play_early_media: false + enter_muted: true + beep_on_enter: false + beep_on_exit: false + events: + mute: + - 1633705131000 + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 49 + packet_loss_percentage: 0.0 + jitter: + avg: 0.34 + max: 0.53 + latency: + avg: 0.0 + max: 0.0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 126 + packet_loss_percentage: 0 + jitter: + avg: 0.01 + max: 0.01 + latency: + avg: 0 + max: 0 + mos: 4.4 + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConferenceParticipant - x-maturity: - - GA /v1/Conferences/{ConferenceSid}/Participants: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - conference_sid - call_sid - account_sid - pathType: list parent: /Conferences/{ConferenceSid} mountName: conference_participants + pathType: list get: - description: List Conference Participants. + description: Get a list of Conference Participants Summaries for a Conference. parameters: - name: ConferenceSid in: path @@ -1877,6 +3342,9 @@ paths: description: User-specified label for a participant. schema: type: string + examples: + readWithLabel: + value: client - name: Events in: query description: Conference events generated by application or participant activity; @@ -1915,38 +3383,228 @@ paths: items: $ref: '#/components/schemas/insights.v1.conference.conference_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=25&Page=0 + next_page_url: null + key: participants + participants: + - participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+10000000001' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:51Z' + leave_time: '2021-10-08T02:59:55Z' + duration_seconds: 65 + outbound_queue_length: 0 + outbound_time_in_queue: 3361 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: true + end_conference_on_exit: false + play_early_media: true + enter_muted: false + beep_on_enter: false + beep_on_exit: false + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 70 + packet_loss_percentage: 0.0 + jitter: + avg: 0.41 + max: 0.84 + latency: + avg: 0.0 + max: 0.0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 126 + packet_loss_percentage: 0 + jitter: + avg: 0.01 + max: 0.01 + latency: + avg: 0 + max: 0 + mos: 4.4 + events: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + label: null + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+10000000002' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:52Z' + leave_time: '2021-10-08T02:59:54Z' + duration_seconds: 63 + outbound_queue_length: 0 + outbound_time_in_queue: 321 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: false + end_conference_on_exit: false + early_media: false + enter_muted: true + beep_on_enter: false + beep_on_exit: false + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 16 + packet_loss_percentage: 0 + jitter: + avg: 0.26 + max: 0.45 + latency: + avg: 0 + max: 0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 42 + packet_loss_percentage: 0 + jitter: + avg: 0.03 + max: 0.08 + latency: + avg: 0 + max: 0 + mos: 4.4 + tags: + - silent + events: + mute: + - 1633705131000 + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + readWithLabel: + value: + meta: + page: 0 + page_size: 25 + first_page_url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0 + previous_page_url: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Label=client&PageSize=25&Page=0 + next_page_url: null + key: participants + participants: + - participant_sid: CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + conference_sid: CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_direction: outbound + from: '+10000000000' + to: '+10000000001' + call_status: completed + country_code: US + is_moderator: true + join_time: '2021-10-08T02:58:51Z' + leave_time: '2021-10-08T02:59:55Z' + duration_seconds: 65 + label: client + outbound_queue_length: 0 + outbound_time_in_queue: 3361 + jitter_buffer_size: null + is_coach: false + coached_participants: null + participant_region: us1 + conference_region: us1 + call_type: carrier + processing_state: complete + properties: + start_conference_on_enter: true + end_conference_on_exit: false + play_early_media: true + enter_muted: false + beep_on_enter: false + beep_on_exit: false + metrics: + inbound: + total_packets_lost: 0 + total_packets_received: 70 + packet_loss_percentage: 0.0 + jitter: + avg: 0.41 + max: 0.84 + latency: + avg: 0.0 + max: 0.0 + mos: 4.4 + outbound: + total_packets_lost: 0 + total_packets_received: 96 + packet_loss_percentage: 0 + jitter: + avg: 0.01 + max: 0.01 + latency: + avg: 0 + max: 0 + mos: 4.4 + events: null + url: https://insights.twilio.com/v1/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListConferenceParticipant - x-maturity: - - GA /v1/Voice/{CallSid}/Events: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - timestamp @@ -1954,14 +3612,14 @@ paths: - account_sid - edge - name - pathType: list parent: /Voice/{Sid} + pathType: list get: - description: '' + description: Get a list of Call Insight Events for a Call. parameters: - name: CallSid in: path - description: '' + description: The unique SID identifier of the Call. schema: type: string minLength: 34 @@ -1970,7 +3628,8 @@ paths: required: true - name: Edge in: query - description: '' + description: The Edge of this Event. One of `unknown_edge`, `carrier_edge`, + `sip_edge`, `sdk_edge` or `client_edge`. schema: type: string $ref: '#/components/schemas/event_enum_twilio_edge' @@ -2006,38 +3665,129 @@ paths: items: $ref: '#/components/schemas/insights.v1.call.event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: events + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0 + events: + - timestamp: '2019-09-19T22:15:23Z' + call_sid: CA03a02b156c6faa96c86906f7e9ad0f38 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + group: connection + name: error + level: ERROR + sdk_edge: + error: + code: 31600 + metadata: + client_name: GTI9300323095d271b890c91568931321395 + location: + lat: 37.4192 + lon: -122.0574 + city: Mountain View + country_code: US + country_subdivision: California + ip_address: 108.177.7.83 + sdk: + type: twilio-voice-android + version: 4.5.1 + platform: android + selected_region: gll + os: + name: android + version: '4.3' + device: + model: GT-I9300 + type: GT-I9300 + vendor: samsung + arch: armeabi-v7a + client_edge: null + carrier_edge: null + sip_edge: null + readDeep: + value: + meta: + page: 10 + page_size: 5 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=0 + previous_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=9&PageToken=DP10 + next_page_url: null + key: events + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=5&Page=10 + events: + - timestamp: '2019-09-19T22:15:23Z' + call_sid: CA03a02b156c6faa96c86906f7e9ad0f38 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + group: connection + name: error + level: ERROR + sdk_edge: + error: + code: 31600 + metadata: + client_name: GTI9300323095d271b890c91568931321395 + location: + lat: 37.4192 + lon: -122.0574 + city: Mountain View + country_code: US + country_subdivision: California + ip_address: 108.177.7.83 + sdk: + type: twilio-voice-android + version: 4.5.1 + platform: android + selected_region: gll + os: + name: android + version: '4.3' + device: + model: GT-I9300 + type: GT-I9300 + vendor: samsung + arch: armeabi-v7a + client_edge: null + carrier_edge: null + sip_edge: null description: OK security: - accountSid_authToken: [] operationId: ListEvent - x-maturity: - - Preview /v1/Voice/{CallSid}/Metrics: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - timestamp @@ -2045,14 +3795,14 @@ paths: - account_sid - edge - direction - pathType: list parent: /Voice/{Sid} + pathType: list get: - description: '' + description: Get a list of Call Metrics for a Call. parameters: - name: CallSid in: path - description: '' + description: The unique SID identifier of the Call. schema: type: string minLength: 34 @@ -2061,16 +3811,24 @@ paths: required: true - name: Edge in: query - description: '' + description: The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, + `sip_edge`, `sdk_edge` or `client_edge`. schema: type: string $ref: '#/components/schemas/metric_enum_twilio_edge' + examples: + readFull: + value: sdk_edge - name: Direction in: query - description: '' + description: The Direction of this Metric. One of `unknown`, `inbound`, `outbound` + or `both`. schema: type: string $ref: '#/components/schemas/metric_enum_stream_direction' + examples: + readFull: + value: both - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2103,53 +3861,130 @@ paths: items: $ref: '#/components/schemas/insights.v1.call.metric' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: metrics + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?PageSize=50&Page=0 + metrics: + - timestamp: '2019-10-07T22:32:06Z' + call_sid: CA7569efe0253644fa4a88aa97beca3310 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + direction: both + sdk_edge: + interval: + packets_received: 50 + packets_lost: 0 + audio_in: + value: 81.0 + audio_out: + value: 5237.0 + jitter: + value: 9 + mos: + value: 4.39 + rtt: + value: 81 + cumulative: + bytes_received: 547788 + bytes_sent: 329425 + packets_received: 3900 + packets_lost: 0 + packets_sent: 3934 + client_edge: null + carrier_edge: null + sip_edge: null + readFull: + value: + meta: + page: 10 + page_size: 5 + first_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=0 + previous_page_url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=9&PageToken=DP10 + next_page_url: null + key: metrics + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Metrics?Direction=both&Edge=sdk_edge&PageSize=5&Page=10 + metrics: + - timestamp: '2019-10-07T22:32:06Z' + call_sid: CA7569efe0253644fa4a88aa97beca3310 + account_sid: AC998c10b68cbfda9f67277f7d8f4439c9 + edge: sdk_edge + direction: both + sdk_edge: + interval: + packets_received: 50 + packets_lost: 0 + audio_in: + value: 81.0 + audio_out: + value: 5237.0 + jitter: + value: 9 + mos: + value: 4.39 + rtt: + value: 81 + cumulative: + bytes_received: 547788 + bytes_sent: 329425 + packets_received: 3900 + packets_lost: 0 + packets_sent: 3934 + client_edge: null + carrier_edge: null + sip_edge: null description: OK security: - accountSid_authToken: [] operationId: ListMetric - x-maturity: - - Preview /v1/Voice/{CallSid}/Summary: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - call_type - call_state - processing_state - duration - pathType: instance parent: /Voice/{Sid} className: call_summary + pathType: instance get: - description: '' + description: Get a specific Call Summary. parameters: - name: CallSid in: path - description: '' + description: The unique SID identifier of the Call. schema: type: string minLength: 34 @@ -2158,7 +3993,8 @@ paths: required: true - name: ProcessingState in: query - description: '' + description: The Processing State of this Call Summary. One of `complete`, + `partial` or `all`. schema: type: string $ref: '#/components/schemas/summary_enum_processing_state' @@ -2168,21 +4004,56 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.call.summary' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_type: carrier + call_state: ringing + answered_by: machine_start + processing_state: complete + created_time: '2015-07-30T20:00:00Z' + start_time: '2015-07-30T20:00:00Z' + end_time: '2015-07-30T20:00:00Z' + duration: 100 + connect_duration: 99 + from: {} + to: {} + carrier_edge: {} + client_edge: {} + sdk_edge: {} + sip_edge: {} + tags: + - tags + attributes: {} + properties: {} + trust: {} + annotation: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + call_sid: CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + answered_by: human + connectivity_issue: invalid_number + quality_issues: + - low_volume + spam: true + call_score: 2 + comment: this is a call + incident: https://twilio.zendesk.com/support/tickets/17353089 + url: https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Summary description: OK security: - accountSid_authToken: [] operationId: FetchSummary - x-maturity: - - GA /v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - pathType: instance parent: /Video/Rooms/{RoomSid} + pathType: instance get: description: Get Video Log Analyzer data for a Room Participant. parameters: @@ -2204,21 +4075,40 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.video_room_summary.video_participant_summary' + examples: + fetch: + value: + publisher_info: {} + edge_location: ashburn + join_time: '2015-07-30T20:00:00Z' + leave_time: '2015-07-30T20:00:00Z' + end_reason: disconnected_via_api + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code: 0 + media_region: us1 + properties: {} + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code_url: error_code_url + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + codecs: + - VP8 + status: in_progress + duration_sec: 50000000 + participant_identity: participant_identity + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchVideoParticipantSummary - x-maturity: - - Beta /v1/Video/Rooms/{RoomSid}/Participants: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - pathType: list parent: /Video/Rooms/{RoomSid} + pathType: list get: description: Get a list of room participants. parameters: @@ -2260,45 +4150,84 @@ paths: items: $ref: '#/components/schemas/insights.v1.video_room_summary.video_participant_summary' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + key: participants + first_page_url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + page: 0 + previous_page_url: null + participants: [] + readFull: + value: + meta: + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + key: participants + first_page_url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + page: 0 + previous_page_url: null + participants: + - publisher_info: {} + edge_location: ashburn + join_time: '2015-07-30T20:00:00Z' + leave_time: '2015-07-30T20:00:00Z' + end_reason: disconnected_via_api + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code: 53205 + media_region: us1 + properties: {} + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + error_code_url: error_code_url + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + codecs: + - VP8 + status: in_progress + duration_sec: 50000000 + participant_identity: participant_identity + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListVideoParticipantSummary - x-maturity: - - Beta /v1/Video/Rooms/{RoomSid}: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - room_sid - create_time - pathType: instance dependentProperties: participant: '{room_sid: room_sid}' + pathType: instance get: description: Get Video Log Analyzer data for a Room. parameters: @@ -2314,23 +4243,52 @@ paths: application/json: schema: $ref: '#/components/schemas/insights.v1.video_room_summary' + examples: + fetch: + value: + room_type: go + unique_participant_identities: 0 + codecs: + - VP8 + max_participants: 0 + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + create_time: '2015-07-30T20:00:00Z' + end_reason: room_ended_via_api + duration_sec: 50000000 + room_status: in_progress + media_region: us1 + recording_enabled: false + edge_location: ashburn + max_concurrent_participants: 0 + unique_participants: 0 + room_name: room_name + created_method: sdk + total_participant_duration_sec: 50000000 + status_callback_method: GET + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + end_time: '2015-07-30T20:00:00Z' + total_recording_duration_sec: 50000000 + processing_state: complete + concurrent_participants: 0 + status_callback: http://www.example.com + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: FetchVideoRoomSummary - x-maturity: - - Beta /v1/Video/Rooms: servers: - url: https://insights.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - room_sid - create_time - pathType: list dependentProperties: participant: '{room_sid: room_sid}' + pathType: list get: description: Get a list of Programmable Video Rooms. parameters: @@ -2400,43 +4358,82 @@ paths: items: $ref: '#/components/schemas/insights.v1.video_room_summary' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + key: rooms + page: 0 + previous_page_url: null + rooms: [] + readFull: + value: + meta: + first_page_url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + url: https://insights.twilio.com/v1/Video/Rooms?PageSize=50&Page=0 + page_size: 50 + next_page_url: null + key: rooms + page: 0 + previous_page_url: null + rooms: + - room_type: go + unique_participant_identities: 0 + codecs: + - VP8 + max_participants: 0 + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + create_time: '2015-07-30T20:00:00Z' + end_reason: room_ended_via_api + duration_sec: 50000000 + room_status: in_progress + media_region: us1 + recording_enabled: false + edge_location: ashburn + max_concurrent_participants: 0 + unique_participants: 0 + room_name: room_name + created_method: sdk + total_participant_duration_sec: 50000000 + status_callback_method: GET + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + end_time: '2015-07-30T20:00:00Z' + total_recording_duration_sec: 50000000 + processing_state: complete + concurrent_participants: 0 + status_callback: http://www.example.com + url: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://insights.twilio.com/v1/Video/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: ListVideoRoomSummary - x-maturity: - - Beta servers: - url: https://insights.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index 64d70d05..6388e3d5 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: intelligence.v2.transcript.media: type: object @@ -335,10 +339,6 @@ components: - outbound - internal - unknown - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Intelligence description: This is the public Twilio REST API. @@ -350,20 +350,20 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Transcripts/{Sid}/Media: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid - service_sid - sid - pathType: instance parent: /Transcripts/{Sid} + pathType: instance get: description: Get download URLs for media if possible parameters: @@ -382,27 +382,43 @@ paths: `true` to access redacted media. schema: type: boolean + examples: + fetchParams: + value: 'True' responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript.media' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_url: https://media.server.com/media.wav + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + fetchParams: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_url: https://media.server.com/media.wav + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchMedia - x-maturity: - - Beta /v2/Transcripts/{TranscriptSid}/OperatorResults: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - operator_sid - pathType: list parent: /Transcripts/{Sid} + pathType: list get: description: Retrieve a list of Operator Results for the given Transcript. parameters: @@ -421,6 +437,9 @@ paths: operator. The default is True. schema: type: boolean + examples: + readFull: + value: 'True' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -453,43 +472,79 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.transcript.operator_result' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + operator_results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0 + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0 + next_page_url: null + key: operator_results + readFull: + value: + operator_results: + - operator_type: conversation_classify + name: name + operator_sid: LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + extract_match: false + match_probability: '0.05' + normalized_result: normalized_result + utterance_results: + - {} + utterance_match: false + predicted_label: predicted_label + predicted_probability: '0.05' + label_probabilities: {} + extract_results: {} + transcript_sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=True&PageSize=50&Page=0 + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=True&PageSize=50&Page=0 + next_page_url: null + key: operator_results description: OK security: - accountSid_authToken: [] operationId: ListOperatorResult - x-maturity: - - Beta /v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - operator_sid - pathType: instance parent: /Transcripts/{Sid} + pathType: instance get: description: Fetch a specific Operator Result for the given Transcript. parameters: @@ -518,22 +573,41 @@ paths: operator. The default is True. schema: type: boolean + examples: + fetch: + value: 'False' responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript.operator_result' + examples: + fetch: + value: + operator_type: conversation_classify + name: name + operator_sid: LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + extract_match: false + match_probability: '0.05' + normalized_result: normalized_result + utterance_results: + - {} + utterance_match: false + predicted_label: predicted_label + predicted_probability: '0.05' + label_probabilities: {} + extract_results: {} + transcript_sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchOperatorResult - x-maturity: - - Beta /v2/Transcripts/{TranscriptSid}/Sentences: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -543,8 +617,8 @@ paths: - start_time - end_time - confidence - pathType: list parent: /Transcripts/{Sid} + pathType: list get: description: Get all Transcript Sentences by TranscriptSid parameters: @@ -563,6 +637,9 @@ paths: is `true` to access redacted sentences. schema: type: boolean + examples: + readParams: + value: 'True' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -595,38 +672,73 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.transcript.sentence' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + sentences: + - media_channel: 1 + sentence_index: 0 + start_time: null + end_time: null + transcript: test test + sid: GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: null + meta: + key: sentences + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0 + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + readParams: + value: + sentences: + - media_channel: 1 + sentence_index: 0 + start_time: null + end_time: null + transcript: test test + sid: GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: null + meta: + key: sentences + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0 + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=True&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null description: OK security: - accountSid_authToken: [] operationId: ListSentence - x-maturity: - - Beta /v2/Services: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -644,12 +756,28 @@ paths: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' + examples: + create: + value: + sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + language_code: en-US + webhook_url: https://www.twilio.com + webhook_http_method: POST + version: 1 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -696,6 +824,14 @@ paths: description: The HTTP method for the Webhook. One of `GET` or `POST`. required: - UniqueName + examples: + create: + value: + UniqueName: something + FriendlyName: some friendly name + LanguageCode: en-US + WebhookUrl: https://www.twilio.com + WebhookHttpMethod: POST get: description: Retrieves a list of all Services for an account. parameters: @@ -731,38 +867,74 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + services: + - sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + language_code: en-US + webhook_url: https://www.twilio.com + webhook_http_method: POST + version: 1 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + key: services + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 + readEmpty: + value: + services: [] + meta: + key: services + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta /v2/Services/{Sid}: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -787,8 +959,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta get: description: Fetch a specific Service. parameters: @@ -804,12 +974,28 @@ paths: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' + examples: + fetch: + value: + sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + language_code: en-US + webhook_url: https://www.twilio.com + webhook_http_method: POST + version: 1 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta post: description: Update a specific Service. parameters: @@ -830,12 +1016,28 @@ paths: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' + examples: + update: + value: + sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: something + friendly_name: some friendly name + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + auto_redaction: false + media_redaction: false + auto_transcribe: true + data_logging: true + webhook_url: https://www.sendgrid.com + webhook_http_method: GET + language_code: en-US + version: 2 + url: https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -880,10 +1082,17 @@ paths: type: string $ref: '#/components/schemas/service_enum_http_method' description: The HTTP method for the Webhook. One of `GET` or `POST`. + examples: + update: + value: + UniqueName: something + FriendlyName: some friendly name + WebhookUrl: https://www.sendgrid.com + WebhookHttpMethod: GET /v2/Transcripts: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -891,11 +1100,11 @@ paths: - media_start_time - duration - status - pathType: list dependentProperties: sentence: '{transcript_sid: sid}' media: '{sid: sid}' operator_result: '{transcript_sid: sid}' + pathType: list post: description: Create a new Transcript for the service responses: @@ -904,12 +1113,55 @@ paths: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: + media_properties: + media_url: http://foobar.test/ClusterTests/call1.wav + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: aaaaaaaa + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + createParams: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: + media_properties: + media_url: http://foobar.test/ClusterTests/call1.wav + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults description: Accepted security: - accountSid_authToken: [] operationId: CreateTranscript - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -938,6 +1190,17 @@ paths: required: - ServiceSid - Channel + examples: + create: + value: + ServiceSid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Channel: '{ "media_properties" : { "media_url": "http://foobar.test/ClusterTests/call1.wav"}}' + CustomerKey: aaaaaaaa + createParams: + value: + ServiceSid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Channel: '{ "media_properties" : { "media_url": "http://foobar.test/ClusterTests/call1.wav"}}' + CustomerKey: aaaaaaaa get: description: Retrieve a list of Transcripts for a given service. parameters: @@ -949,6 +1212,13 @@ paths: minLength: 34 maxLength: 34 pattern: ^GA[0-9a-fA-F]{32}$ + examples: + readFull: + value: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readQuery: + value: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: BeforeStartTime in: query description: Filter by before StartTime. @@ -969,6 +1239,9 @@ paths: description: Filter by after DateCreated. schema: type: string + examples: + readFull: + value: '2019-11-22T23:46:00Z' - name: Status in: query description: Filter by status. @@ -979,11 +1252,17 @@ paths: description: Filter by Language Code. schema: type: string + examples: + readFull: + value: en-US - name: SourceSid in: query description: Filter by SourceSid. schema: type: string + examples: + readFull: + value: REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1016,38 +1295,106 @@ paths: items: $ref: '#/components/schemas/intelligence.v2.transcript' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + transcripts: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + meta: + key: transcripts + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0 + readEmpty: + value: + transcripts: [] + meta: + key: transcripts + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readQuery: + value: + transcripts: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + meta: + key: transcripts + page: 0 + page_size: 50 + first_page_url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + url: https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTranscript - x-maturity: - - Beta /v2/Transcripts/{Sid}: servers: - url: https://intelligence.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1055,11 +1402,11 @@ paths: - media_start_time - duration - status - pathType: instance dependentProperties: sentence: '{transcript_sid: sid}' media: '{sid: sid}' operator_result: '{transcript_sid: sid}' + pathType: instance get: description: Fetch a specific Transcript. parameters: @@ -1078,18 +1425,60 @@ paths: is `true` to access redacted Transcript. schema: type: boolean + examples: + fetchParam: + value: 'True' responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.transcript' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults + fetchParam: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-08-31T20:36:28Z' + date_updated: '2010-08-31T20:36:28Z' + status: queued + channel: {} + data_logging: false + language_code: en-US + media_start_time: null + duration: 0 + customer_key: null + url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + redaction: true + links: + sentences: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences + media: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + operator_results: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults description: OK security: - accountSid_authToken: [] operationId: FetchTranscript - x-maturity: - - Beta delete: description: Delete a specific Transcript. parameters: @@ -1108,11 +1497,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTranscript - x-maturity: - - Beta servers: - url: https://intelligence.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 9bd67582..05adacad 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: ip_messaging.v1.service.channel: type: object @@ -520,10 +524,6 @@ components: - joined - invited - not_participating - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Ip_messaging description: This is the public Twilio REST API. @@ -535,24 +535,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -577,12 +577,31 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' parameters: @@ -607,8 +626,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' parameters: @@ -633,12 +650,31 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -655,21 +691,28 @@ paths: Attributes: type: string description: '' + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' /v1/Services/{ServiceSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -688,12 +731,31 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -714,6 +776,13 @@ paths: type: string $ref: '#/components/schemas/channel_enum_channel_type' description: '' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' get: description: '' parameters: @@ -766,38 +835,77 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v1/Credentials: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -839,34 +947,63 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' responses: @@ -875,12 +1012,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -912,10 +1058,14 @@ paths: description: '' required: - Type + examples: + create: + value: + Type: apn /v1/Credentials/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -940,12 +1090,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' parameters: @@ -964,12 +1123,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -995,6 +1163,10 @@ paths: Secret: type: string description: '' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' parameters: @@ -1013,19 +1185,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1059,12 +1229,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' parameters: @@ -1098,19 +1279,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -1135,12 +1314,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1159,6 +1349,11 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -1184,6 +1379,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1216,45 +1418,76 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1288,12 +1521,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' parameters: @@ -1327,8 +1572,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' parameters: @@ -1362,12 +1605,37 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 666 + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1385,17 +1653,24 @@ paths: type: integer nullable: true description: '' + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 666 /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -1420,12 +1695,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1444,6 +1731,10 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: Twilio get: description: '' parameters: @@ -1501,46 +1792,78 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1577,12 +1900,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' parameters: @@ -1619,8 +1956,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' parameters: @@ -1657,12 +1992,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{"test": "test"}' + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1676,18 +2025,22 @@ paths: Attributes: type: string description: '' + examples: + update: + value: + Body: Hello /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -1715,12 +2068,41 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAttributes: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1739,6 +2121,14 @@ paths: description: '' required: - Body + examples: + create: + value: + Body: Hello + createWithAttributes: + value: + Body: Hello + Attributes: '{"test": "test"}' get: description: '' parameters: @@ -1798,45 +2188,79 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v1/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -1864,12 +2288,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' parameters: @@ -1897,8 +2335,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' parameters: @@ -1926,12 +2362,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1946,17 +2396,21 @@ paths: description: '' required: - Permission + examples: + update: + value: + Permission: sendMessage /v1/Services/{ServiceSid}/Roles: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -1975,12 +2429,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2004,6 +2472,12 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' parameters: @@ -2048,48 +2522,82 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' + pathType: instance get: description: '' parameters: @@ -2108,12 +2616,40 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' parameters: @@ -2132,8 +2668,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' parameters: @@ -2152,12 +2686,116 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: + on_channel_add: + format: webhooks.on_channel_add.format + method: webhooks.on_channel_add.method + url: webhooks.on_channel_add.url + on_channel_added: + format: webhooks.on_channel_added.format + method: webhooks.on_channel_added.method + url: webhooks.on_channel_added.url + on_channel_destroy: + format: webhooks.on_channel_destroy.format + method: webhooks.on_channel_destroy.method + url: webhooks.on_channel_destroy.url + on_channel_destroyed: + format: webhooks.on_channel_destroyed.format + method: webhooks.on_channel_destroyed.method + url: webhooks.on_channel_destroyed.url + on_channel_update: + format: webhooks.on_channel_update.format + method: webhooks.on_channel_update.method + url: webhooks.on_channel_update.url + on_channel_updated: + format: webhooks.on_channel_updated.format + method: webhooks.on_channel_updated.method + url: webhooks.on_channel_updated.url + on_member_add: + format: webhooks.on_member_add.format + method: webhooks.on_member_add.method + url: webhooks.on_member_add.url + on_member_added: + format: webhooks.on_member_added.format + method: webhooks.on_member_added.method + url: webhooks.on_member_added.url + on_member_remove: + format: webhooks.on_member_remove.format + method: webhooks.on_member_remove.method + url: webhooks.on_member_remove.url + on_member_removed: + format: webhooks.on_member_removed.format + method: webhooks.on_member_removed.method + url: webhooks.on_member_removed.url + on_message_remove: + format: webhooks.on_message_remove.format + method: webhooks.on_message_remove.method + url: webhooks.on_message_remove.url + on_message_removed: + format: webhooks.on_message_removed.format + method: webhooks.on_message_removed.method + url: webhooks.on_message_removed.url + on_message_send: + format: webhooks.on_message_send.format + method: webhooks.on_message_send.method + url: webhooks.on_message_send.url + on_message_sent: + format: webhooks.on_message_sent.format + method: webhooks.on_message_sent.method + url: webhooks.on_message_sent.url + on_message_update: + format: webhooks.on_message_update.format + method: webhooks.on_message_update.method + url: webhooks.on_message_update.url + on_message_updated: + format: webhooks.on_message_updated.format + method: webhooks.on_message_updated.method + url: webhooks.on_message_updated.url description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2492,20 +3130,94 @@ paths: Limits.UserChannels: type: integer description: '' + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Webhooks.OnChannelAdd.Format: webhooks.on_channel_add.format + Webhooks.OnChannelAdd.Method: webhooks.on_channel_add.method + Webhooks.OnChannelAdd.Url: webhooks.on_channel_add.url + Webhooks.OnChannelAdded.Format: webhooks.on_channel_added.format + Webhooks.OnChannelAdded.Method: webhooks.on_channel_added.method + Webhooks.OnChannelAdded.Url: webhooks.on_channel_added.url + Webhooks.OnChannelDestroy.Format: webhooks.on_channel_destroy.format + Webhooks.OnChannelDestroy.Method: webhooks.on_channel_destroy.method + Webhooks.OnChannelDestroy.Url: webhooks.on_channel_destroy.url + Webhooks.OnChannelDestroyed.Format: webhooks.on_channel_destroyed.format + Webhooks.OnChannelDestroyed.Method: webhooks.on_channel_destroyed.method + Webhooks.OnChannelDestroyed.Url: webhooks.on_channel_destroyed.url + Webhooks.OnChannelUpdate.Format: webhooks.on_channel_update.format + Webhooks.OnChannelUpdate.Method: webhooks.on_channel_update.method + Webhooks.OnChannelUpdate.Url: webhooks.on_channel_update.url + Webhooks.OnChannelUpdated.Format: webhooks.on_channel_updated.format + Webhooks.OnChannelUpdated.Method: webhooks.on_channel_updated.method + Webhooks.OnChannelUpdated.Url: webhooks.on_channel_updated.url + Webhooks.OnMemberAdd.Format: webhooks.on_member_add.format + Webhooks.OnMemberAdd.Method: webhooks.on_member_add.method + Webhooks.OnMemberAdd.Url: webhooks.on_member_add.url + Webhooks.OnMemberAdded.Format: webhooks.on_member_added.format + Webhooks.OnMemberAdded.Method: webhooks.on_member_added.method + Webhooks.OnMemberAdded.Url: webhooks.on_member_added.url + Webhooks.OnMemberRemove.Format: webhooks.on_member_remove.format + Webhooks.OnMemberRemove.Method: webhooks.on_member_remove.method + Webhooks.OnMemberRemove.Url: webhooks.on_member_remove.url + Webhooks.OnMemberRemoved.Format: webhooks.on_member_removed.format + Webhooks.OnMemberRemoved.Method: webhooks.on_member_removed.method + Webhooks.OnMemberRemoved.Url: webhooks.on_member_removed.url + Webhooks.OnMessageRemove.Format: webhooks.on_message_remove.format + Webhooks.OnMessageRemove.Method: webhooks.on_message_remove.method + Webhooks.OnMessageRemove.Url: webhooks.on_message_remove.url + Webhooks.OnMessageRemoved.Format: webhooks.on_message_removed.format + Webhooks.OnMessageRemoved.Method: webhooks.on_message_removed.method + Webhooks.OnMessageRemoved.Url: webhooks.on_message_removed.url + Webhooks.OnMessageSend.Format: webhooks.on_message_send.format + Webhooks.OnMessageSend.Method: webhooks.on_message_send.method + Webhooks.OnMessageSend.Url: webhooks.on_message_send.url + Webhooks.OnMessageSent.Format: webhooks.on_message_sent.format + Webhooks.OnMessageSent.Method: webhooks.on_message_sent.method + Webhooks.OnMessageSent.Url: webhooks.on_message_sent.url + Webhooks.OnMessageUpdate.Format: webhooks.on_message_update.format + Webhooks.OnMessageUpdate.Method: webhooks.on_message_update.method + Webhooks.OnMessageUpdate.Url: webhooks.on_message_update.url + Webhooks.OnMessageUpdated.Format: webhooks.on_message_updated.format + Webhooks.OnMessageUpdated.Method: webhooks.on_message_updated.method + Webhooks.OnMessageUpdated.Url: webhooks.on_message_updated.url /v1/Services: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' + pathType: list post: description: '' responses: @@ -2514,12 +3226,40 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2532,6 +3272,10 @@ paths: description: '' required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' parameters: @@ -2567,47 +3311,95 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + webhooks: {} description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -2632,12 +3424,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' parameters: @@ -2662,8 +3470,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' parameters: @@ -2688,12 +3494,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2713,19 +3535,25 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v1/Services/{ServiceSid}/Users: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -2744,12 +3572,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2774,6 +3618,13 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' parameters: @@ -2818,45 +3669,81 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: '' parameters: @@ -2907,36 +3794,64 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v1.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + links: + channel: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA servers: - url: https://ip-messaging.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index a3e37b1a..65a90935 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: ip_messaging.v2.service.binding: type: object @@ -761,10 +765,6 @@ components: enum: - default - muted - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Ip_messaging description: This is the public Twilio REST API. @@ -776,20 +776,20 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - pathType: list parent: /Services/{Sid} + pathType: list get: description: '' parameters: @@ -849,45 +849,83 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -915,12 +953,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + user: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser description: OK security: - accountSid_authToken: [] operationId: FetchBinding - x-maturity: - - GA delete: description: '' parameters: @@ -948,24 +1004,22 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: instance dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' webhook: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -990,12 +1044,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' + examples: + fetch: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: FetchChannel - x-maturity: - - GA delete: description: '' parameters: @@ -1026,8 +1100,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannel - x-maturity: - - GA post: description: '' parameters: @@ -1058,12 +1130,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' + examples: + update: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: OK security: - accountSid_authToken: [] operationId: UpdateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1091,22 +1183,32 @@ paths: CreatedBy: type: string description: '' + examples: + update: + value: + Type: channel + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username /v2/Services/{ServiceSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - pathType: list dependentProperties: member: '{service_sid: service_sid, channel_sid: sid}' message: '{service_sid: service_sid, channel_sid: sid}' invite: '{service_sid: service_sid, channel_sid: sid}' webhook: '{service_sid: service_sid, channel_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -1131,12 +1233,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' + examples: + create: + value: + sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + created_by: username + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null description: Created security: - accountSid_authToken: [] operationId: CreateChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1168,6 +1290,16 @@ paths: CreatedBy: type: string description: '' + examples: + create: + value: + Type: public + FriendlyName: friendly_name + UniqueName: unique_name + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + CreatedBy: username get: description: '' parameters: @@ -1220,44 +1352,84 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + unique_name: unique_name + attributes: '{ "foo": "bar" }' + type: public + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:37Z' + created_by: system + members_count: 0 + messages_count: 0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + members: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members + messages: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + invites: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites + webhooks: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + last_message: null + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + readEmpty: + value: + channels: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels description: OK security: - accountSid_authToken: [] operationId: ListChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - configuration - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list get: description: '' parameters: @@ -1308,34 +1480,95 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + next_page_url: null + key: webhooks + webhooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 5 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 + previous_page_url: null + next_page_url: null + key: webhooks + webhooks: [] description: OK security: - accountSid_authToken: [] operationId: ListChannelWebhook - x-maturity: - - GA post: description: '' parameters: @@ -1360,12 +1593,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: webhook + configuration: + url: dummy + method: GET + filters: + - onMessageSent + - onChannelDestroyed + retry_count: 2 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1405,16 +1654,26 @@ paths: description: '' required: - Type + examples: + create: + value: + Type: webhook + Configuration.Url: dummy + Configuration.Method: GET + Configuration.Filters: + - onMessageSent + - onChannelDestroyed + Configuration.RetryCount: 2 /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - configuration - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1448,12 +1707,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: studio + configuration: + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchChannelWebhook - x-maturity: - - GA post: description: '' parameters: @@ -1487,12 +1757,28 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: trigger + configuration: + url: dummy + method: POST + filters: + - keyword1 + - keyword2 + retry_count: 3 + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateChannelWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1526,6 +1812,15 @@ paths: Configuration.RetryCount: type: integer description: '' + examples: + update: + value: + Configuration.Url: dummy + Configuration.Method: POST + Configuration.Triggers: + - keyword1 + - keyword2 + Configuration.RetryCount: 5 delete: description: '' parameters: @@ -1559,12 +1854,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteChannelWebhook - x-maturity: - - GA /v2/Credentials: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1606,34 +1899,63 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - GA post: description: '' responses: @@ -1642,12 +1964,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1679,10 +2010,14 @@ paths: description: '' required: - Type + examples: + create: + value: + Type: apn /v2/Credentials/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1707,12 +2042,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - GA post: description: '' parameters: @@ -1731,12 +2075,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://ip-messaging.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1762,6 +2115,10 @@ paths: Secret: type: string description: '' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' parameters: @@ -1780,19 +2137,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -1826,12 +2181,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInvite - x-maturity: - - GA delete: description: '' parameters: @@ -1865,19 +2231,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -1902,12 +2266,23 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateInvite - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1926,6 +2301,11 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: identity + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -1951,6 +2331,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1983,45 +2370,76 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + invites: [] + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + readFull: + value: + invites: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + identity: identity + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 + key: invites + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListInvite - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -2052,12 +2470,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' + examples: + fetch: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMember - x-maturity: - - GA delete: description: '' parameters: @@ -2094,8 +2525,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMember - x-maturity: - - GA post: description: '' parameters: @@ -2132,12 +2561,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' + examples: + updateRoleSid: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: 20 + last_consumption_timestamp: '2016-03-24T21:05:52Z' + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:51Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2170,17 +2612,26 @@ paths: Attributes: type: string description: '' + examples: + updateRoleSid: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DateCreated: '2016-03-24T21:05:50Z' + DateUpdated: '2016-03-24T21:05:51Z' + LastConsumedMessageIndex: 20 + LastConsumptionTimestamp: '2016-03-24T21:05:52Z' + Attributes: '{}' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -2211,12 +2662,25 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' + examples: + create: + value: + sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMember - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2254,6 +2718,11 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: Twilio + Attributes: '{}' get: description: '' parameters: @@ -2311,46 +2780,79 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: + - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + last_consumed_message_index: null + last_consumption_timestamp: null + date_created: '2016-03-24T21:05:50Z' + date_updated: '2016-03-24T21:05:50Z' + attributes: '{}' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 + next_page_url: null + key: members + members: [] description: OK security: - accountSid_authToken: [] operationId: ListMember - x-maturity: - - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: instance get: description: '' parameters: @@ -2384,12 +2886,51 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' + examples: + fetch: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessage - x-maturity: - - GA delete: description: '' parameters: @@ -2429,8 +2970,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessage - x-maturity: - - GA post: description: '' parameters: @@ -2470,12 +3009,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' + examples: + update: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{ "foo": "bar" }' + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: fromUser + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2503,18 +3059,27 @@ paths: From: type: string description: '' + examples: + update: + value: + Body: Hello + Attributes: '{ "foo": "bar" }' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + From: fromUser /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created - pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} + pathType: list post: description: '' parameters: @@ -2545,12 +3110,69 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' + examples: + create: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithAll: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-12-16T22:18:37Z' + date_updated: '2015-12-16T22:18:38Z' + last_updated_by: username + was_edited: true + from: system + attributes: '{"test": "test"}' + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createMedia: + value: + sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: null + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: system + was_edited: false + from: system + body: Hello + index: 0 + type: text + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2584,6 +3206,20 @@ paths: maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ description: '' + examples: + create: + value: + Body: Hello + createWithAll: + value: + Body: Hello + Attributes: '{"test": "test"}' + DateCreated: '2015-12-16T22:18:37Z' + DateUpdated: '2015-12-16T22:18:38Z' + LastUpdatedBy: username + createMedia: + value: + MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -2640,45 +3276,102 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: text + media: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-03-24T20:37:57Z' + date_updated: '2016-03-24T20:37:57Z' + last_updated_by: null + was_edited: false + from: system + attributes: '{}' + body: Hello + index: 0 + type: media + media: + sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 99999999999999 + content_type: application/pdf + filename: hello.pdf + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 + next_page_url: null + key: messages + messages: [] description: OK security: - accountSid_authToken: [] operationId: ListMessage - x-maturity: - - GA /v2/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -2706,12 +3399,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' + examples: + fetch: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRole - x-maturity: - - GA delete: description: '' parameters: @@ -2739,8 +3446,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRole - x-maturity: - - GA post: description: '' parameters: @@ -2768,12 +3473,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' + examples: + update: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2788,17 +3507,21 @@ paths: description: '' required: - Permission + examples: + update: + value: + Permission: sendMessage /v2/Services/{ServiceSid}/Roles: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -2817,12 +3540,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' + examples: + create: + value: + sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRole - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2846,6 +3583,12 @@ paths: - FriendlyName - Type - Permission + examples: + create: + value: + FriendlyName: friendly_name + Type: channel + Permission: sendMessage get: description: '' parameters: @@ -2890,49 +3633,83 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.role' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: + - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: channel user + type: channel + permissions: + - sendMessage + - leaveChannel + - editOwnMessage + - deleteOwnMessage + date_created: '2016-03-03T19:47:15Z' + date_updated: '2016-03-03T19:47:15Z' + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 + next_page_url: null + key: roles + roles: [] description: OK security: - accountSid_authToken: [] operationId: ListRole - x-maturity: - - GA /v2/Services/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' binding: '{service_sid: sid}' + pathType: instance get: description: '' parameters: @@ -2951,12 +3728,45 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' parameters: @@ -2975,8 +3785,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' parameters: @@ -2995,12 +3803,59 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 500 + user_channels: 600 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: + log_enabled: true + added_to_channel: + enabled: false + template: notifications.added_to_channel.template + invited_to_channel: + enabled: false + template: notifications.invited_to_channel.template + new_message: + enabled: false + template: notifications.new_message.template + badge_count_enabled: true + removed_from_channel: + enabled: false + template: notifications.removed_from_channel.template + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: new media compatibility message description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3122,21 +3977,52 @@ paths: Notifications.LogEnabled: type: boolean description: '' + examples: + update: + value: + ConsumptionReportInterval: 100 + DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + Notifications.AddedToChannel.Enabled: false + Notifications.AddedToChannel.Template: notifications.added_to_channel.template + Notifications.InvitedToChannel.Enabled: false + Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template + Notifications.NewMessage.Enabled: false + Notifications.NewMessage.Template: notifications.new_message.template + Notifications.NewMessage.BadgeCountEnabled: true + Notifications.RemovedFromChannel.Enabled: false + Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template + Notifications.LogEnabled: true + Limits.ChannelMembers: 600 + Limits.UserChannels: 500 + PostWebhookUrl: post_webhook_url + PreWebhookUrl: pre_webhook_url + PreWebhookRetryCount: 2 + PostWebhookRetryCount: 3 + ReachabilityEnabled: false + ReadStatusEnabled: false + TypingIndicatorTimeout: 100 + WebhookFilters: + - webhook_filters + WebhookMethod: webhook_method + Media.CompatibilityMessage: new media compatibility message /v2/Services: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: channel: '{service_sid: sid}' role: '{service_sid: sid}' user: '{service_sid: sid}' binding: '{service_sid: sid}' + pathType: list post: description: '' responses: @@ -3145,12 +4031,45 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3163,6 +4082,10 @@ paths: description: '' required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name get: description: '' parameters: @@ -3198,49 +4121,102 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + consumption_report_interval: 100 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + limits: + channel_members: 100 + user_channels: 250 + links: + channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + users: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + roles: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles + bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: {} + post_webhook_url: post_webhook_url + pre_webhook_url: pre_webhook_url + pre_webhook_retry_count: 2 + post_webhook_retry_count: 3 + reachability_enabled: false + read_status_enabled: false + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + typing_indicator_timeout: 100 + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_filters: + - webhook_filters + webhook_method: webhook_method + media: + size_limit_mb: 150 + compatibility_message: media compatibility message description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created - pathType: instance dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' user_binding: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -3265,12 +4241,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' + examples: + fetch: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUser - x-maturity: - - GA delete: description: '' parameters: @@ -3295,8 +4288,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUser - x-maturity: - - GA post: description: '' parameters: @@ -3327,12 +4318,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' + examples: + update: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3352,21 +4360,27 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name /v2/Services/{ServiceSid}/Users: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created - pathType: list dependentProperties: user_channel: '{service_sid: service_sid, user_sid: sid}' user_binding: '{service_sid: service_sid, user_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -3391,12 +4405,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' + examples: + create: + value: + sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + joined_channels_count: 0 + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3421,6 +4452,13 @@ paths: description: '' required: - Identity + examples: + create: + value: + Identity: jing + RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: '{"test":"test"}' + FriendlyName: friendly_name get: description: '' parameters: @@ -3465,47 +4503,84 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: + - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: jing + attributes: null + is_online: true + is_notifiable: null + friendly_name: null + date_created: '2016-03-24T21:05:19Z' + date_updated: '2016-03-24T21:05:19Z' + joined_channels_count: 0 + links: + user_channels: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + user_bindings: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 + next_page_url: null + key: users + users: [] description: OK security: - accountSid_authToken: [] operationId: ListUser - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: list get: description: '' parameters: @@ -3564,47 +4639,84 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: + - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 + next_page_url: null + key: bindings + bindings: [] description: OK security: - accountSid_authToken: [] operationId: ListUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings + pathType: instance get: description: '' parameters: @@ -3638,12 +4750,29 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_binding' + examples: + fetch: + value: + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-10-21T11:37:03Z' + date_updated: '2016-10-21T11:37:03Z' + endpoint: TestUser-endpoint + identity: TestUser + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + binding_type: gcm + credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + message_types: + - removed_from_channel + - new_message + - added_to_channel + - invited_to_channel + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserBinding - x-maturity: - - GA delete: description: '' parameters: @@ -3677,19 +4806,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserBinding - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: list get: description: '' parameters: @@ -3740,45 +4867,79 @@ paths: items: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + previous_page_url: null + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + next_page_url: null + key: channels + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListUserChannel - x-maturity: - - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: servers: - url: https://ip-messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - channel_sid - status - pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels + pathType: instance get: description: '' parameters: @@ -3809,12 +4970,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: default + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchUserChannel - x-maturity: - - GA delete: description: '' parameters: @@ -3845,8 +5020,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUserChannel - x-maturity: - - GA post: description: '' parameters: @@ -3877,12 +5050,41 @@ paths: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' + examples: + updateNotificationLevel: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 5 + unread_messages_count: 5 + notification_level: muted + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateLastConsumedMessageIndex: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: joined + last_consumed_message_index: 10 + unread_messages_count: 5 + notification_level: muted + url: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channel: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + member: https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateUserChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3902,8 +5104,12 @@ paths: type: string format: date-time description: '' + examples: + updateNotificationLevel: + value: + NotificationLevel: muted + updateLastConsumedMessageIndex: + value: + LastConsumedMessageIndex: 10 servers: - url: https://ip-messaging.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_lookups_bulk.yaml b/spec/yaml/twilio_lookups_bulk.yaml new file mode 100644 index 00000000..24fe2e6b --- /dev/null +++ b/spec/yaml/twilio_lookups_bulk.yaml @@ -0,0 +1,302 @@ +openapi: 3.0.3 +info: + title: Lookup + termsOfService: https://www.twilio.com/legal/tos + version: 1.0.0-alpha.1 + description: 'Lookup APIs for individual, bulk and job based requests + + + Discussion topics: + + - API version to use + + - Using or not lookup in the path or just as lookups subdomain' + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html +servers: +- url: https://lookups.twilio.com +paths: + /v2/batch/query: + post: + summary: In Request Bulk + operationId: post-bulkLookup + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LookupResponseWithCorId' + requestBody: + content: + application/json: + schema: + type: object + title: LookupRequest + properties: + LookupRequests: + type: array + items: + $ref: '#/components/schemas/LookupRequestWithCorId' + description: 'Discussions made regarding how to help the customer to correlation + request and response objects: + + - Respecting the natural order (requests vs. response) + + - Using phone numbers as unique key + + - Adding a correlation_id key' + security: + - accountSid_authToken: [] + parameters: [] +components: + schemas: + LookupRequest: + title: Lookup request + type: object + properties: + phone_number: + type: string + fields: + type: array + items: + type: string + enum: + - caller_name + - sim_swap + - call_forwarding + - live_activity + - line_type_intelligence + - identity_match + - reassigned_number + country_code: + type: string + identity_match: + $ref: '#/components/schemas/IdentityMatchParameters' + reassigned_number: + $ref: '#/components/schemas/ReassignedNumberRequest' + required: + - phone_number + description: '' + LookupRequestWithCorId: + title: LookupRequestWithCorId + allOf: + - $ref: '#/components/schemas/LookupRequest' + type: object + properties: + correlation_id: + type: string + description: Unique identifier used to match request with response + LookupResponse: + title: LookupResponse + type: object + properties: + calling_country_code: + type: string + country_code: + type: string + phone_number: + type: string + national_format: + type: string + valid: + type: boolean + validation_errors: + type: array + items: + type: string + caller_name: + $ref: '#/components/schemas/CallerName' + sim_swap: + $ref: '#/components/schemas/SimSwap' + call_forwarding: + $ref: '#/components/schemas/CallForwarding' + live_activity: + $ref: '#/components/schemas/LiveActivity' + line_type_intelligence: + $ref: '#/components/schemas/LineTypeIntelligence' + identity_match: + $ref: '#/components/schemas/IdentityMatch' + reassigned_number: + $ref: '#/components/schemas/ReassignedNumberResponse' + LookupResponseWithCorId: + allOf: + - $ref: '#/components/schemas/LookupResponse' + type: object + properties: + correlation_id: + type: string + description: Unique identifier used to match request with response + twilio_error_code: + type: integer + description: Twilio error conde in case that the request to downstream fails + CallerName: + title: CallerName + type: object + properties: + caller_name: + type: string + caller_type: + type: string + error_code: + type: integer + SimSwap: + title: SimSwap + allOf: + - $ref: '#/components/schemas/ATOCarrier' + properties: + last_sim_swap: + $ref: '#/components/schemas/LastSimSwap' + error_code: + type: integer + type: object + LastSimSwap: + title: SimSwap + properties: + last_sim_swap_date: + type: string + format: date-time + swapped_period: + type: string + swapped_in_period: + type: boolean + CallForwarding: + title: CallForwarding + type: object + allOf: + - $ref: '#/components/schemas/ATOCarrier' + properties: + call_forwarding_enabled: + type: boolean + error_code: + type: integer + ATOCarrier: + title: ATOCarrier + type: object + allOf: + - $ref: '#/components/schemas/Carrier' + properties: + carrier_name: + type: string + LiveActivity: + title: LiveActivity + type: object + properties: + connectivity: + type: string + original_carrier: + $ref: '#/components/schemas/LiveActivityCarrier' + ported: + type: string + ported_carrier: + $ref: '#/components/schemas/LiveActivityCarrier' + roaming: + type: string + roaming_carrier: + $ref: '#/components/schemas/LiveActivityCarrier' + error_code: + type: integer + LiveActivityCarrier: + title: LiveActivityCarrier + allOf: + - $ref: '#/components/schemas/Carrier' + properties: + name: + type: string + country: + type: string + type: object + LineTypeIntelligence: + title: Packages/LineTypeIntelligence + type: object + allOf: + - $ref: '#/components/schemas/ATOCarrier' + properties: + type: + type: string + error_code: + type: integer + Carrier: + title: Carrier + type: object + properties: + mobile_country_code: + type: string + mobile_network_code: + type: string + IdentityMatch: + title: IdentityMatch + type: object + properties: + first_name_match: + type: string + last_name_match: + type: string + address_line_match: + type: string + city_match: + type: string + state_match: + type: string + postal_code_match: + type: string + country_code_match: + type: string + national_id_match: + type: string + date_of_birth_match: + type: string + summary_score: + type: integer + error_code: + type: integer + error_message: + type: string + IdentityMatchParameters: + title: IdentityMatchParameters + type: object + properties: + first_name: + type: string + last_name: + type: string + address_line1: + type: string + address_line2: + type: string + city: + type: string + state: + type: string + postal_code: + type: string + address_country_code: + type: string + national_id: + type: string + date_of_birth: + type: string + ReassignedNumberRequest: + title: ReassignedNumberRequest + type: object + properties: + last_verified_date: + type: string + ReassignedNumberResponse: + title: ReassignedNumberResponse + type: object + properties: + last_verified_date: + type: string + status: + type: string + error_code: + type: string + requestBodies: {} diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 53794eff..96e14dae 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: lookups.v1.phone_number: type: object @@ -42,10 +46,6 @@ components: - landline - mobile - voip - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Lookups description: This is the public Twilio REST API. @@ -57,7 +57,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: @@ -89,6 +89,19 @@ paths: phone number is provided in a national format. schema: type: string + examples: + fetchCarrier: + value: country_code + fetchCarrierInternational: + value: country_code + fetchCallerName: + value: country_code + fetchCarrierAndCallerName: + value: country_code + fetchAddonsWhitepagesPro: + value: country_code + fetchAddonsPayfone: + value: country_code - name: Type in: query description: 'The type of information to return. Can be: `carrier` or `caller-name`. @@ -101,6 +114,31 @@ paths: type: array items: type: string + examples: + fetch: + value: [] + fetchCarrier: + value: + - carrier + fetchCarrierInternational: + value: + - carrier + fetchCallerName: + value: + - caller-name + fetchCarrierAndCallerName: + value: + - carrier + - caller-name + fetchAddonsWhitepagesPro: + value: + - caller-name + fetchAddonsNomorobo: + value: + - carrier + fetchAddonsPayfone: + value: + - carrier - name: AddOns in: query description: The `unique_name` of an Add-on you would like to invoke. Can @@ -111,6 +149,16 @@ paths: type: array items: type: string + examples: + fetchAddonsWhitepagesPro: + value: + - whitepages_pro_caller_id + fetchAddonsNomorobo: + value: + - nomorobo_spamscore + fetchAddonsPayfone: + value: + - payfone_tcpa_compliance - name: AddOnsData in: query description: Data specific to the add-on you would like to invoke. The content @@ -124,14 +172,199 @@ paths: application/json: schema: $ref: '#/components/schemas/lookups.v1.phone_number' + examples: + fetch: + value: + caller_name: null + carrier: null + fraud: null + add_ons: null + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchCarrier: + value: + caller_name: null + carrier: + error_code: null + mobile_country_code: '310' + mobile_network_code: '456' + name: verizon + type: mobile + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + fraud: null + add_ons: null + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchCarrierInternational: + value: + caller_name: null + carrier: + error_code: null + mobile_country_code: null + mobile_network_code: null + name: Vodafone Business Solutions + type: landline + country_code: GB + national_format: 020 7765 1182 + phone_number: '+4402077651182' + fraud: null + add_ons: null + url: https://lookups.twilio.com/v1/PhoneNumbers/+4402077651182 + fetchCallerName: + value: + caller_name: + caller_name: Delicious Cheese Cake + caller_type: CONSUMER + error_code: null + carrier: null + fraud: null + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + add_ons: null + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchCarrierAndCallerName: + value: + caller_name: + caller_name: Delicious Cheese Cake + caller_type: CONSUMER + error_code: null + carrier: + error_code: null + mobile_country_code: '310' + mobile_network_code: '456' + name: verizon + type: mobile + fraud: null + country_code: US + national_format: (510) 867-5310 + phone_number: '+15108675310' + add_ons: + status: successful + message: null + code: null + results: {} + url: https://lookups.twilio.com/v1/PhoneNumbers/+15108675310 + fetchAddonsWhitepagesPro: + value: + caller_name: + caller_name: EMPIRE STATE BUILDING + caller_type: BUSINESS + error_code: null + country_code: US + phone_number: '+12127363100' + national_format: (212) 736-3100 + carrier: null + fraud: null + add_ons: + status: successful + message: null + code: null + results: + whitepages_pro_caller_id: + status: successful + request_sid: XR28b8f152ae12345605b0b3cc34123456 + message: null + code: null + result: + phone_number: '2127363100' + warnings: [] + historical_addresses: [] + alternate_phones: [] + error: null + is_commercial: true + associated_people: [] + country_calling_code: '1' + belongs_to: [] + is_valid: true + line_type: NonFixedVOIP + carrier: Level 3 Communications + current_addresses: + - city: New York + lat_long: + latitude: 40.748731 + longitude: -73.986413 + accuracy: RoofTop + is_active: null + location_type: Address + street_line_2: null + link_to_person_start_date: '2018-08-28' + street_line_1: 350 5th Ave + postal_code: '10118' + delivery_point: MultiUnit + country_code: US + state_code: NY + id: Location.4e81b857-1234-5678-31d29a3301e1 + zip4: '0110' + id: Phone.f8396fef-1234-5678-bc7128b6fd99 + is_prepaid: false + url: https://lookups.twilio.com/v1/PhoneNumbers/+12127363100 + fetchAddonsNomorobo: + value: + caller_name: null + country_code: US + phone_number: '+19892008374' + national_format: (989) 200-8374 + carrier: + mobile_country_code: '310' + mobile_network_code: null + name: Ytel/Blitz + type: mobile + error_code: null + fraud: null + add_ons: + status: successful + message: null + code: null + results: + nomorobo_spamscore: + status: successful + request_sid: XR763c8acc4c56d5e3e18d2f0f12345bc1 + message: null + code: null + result: + status: success + message: success + score: 1 + url: https://lookups.twilio.com/v1/PhoneNumbers/+19892008374 + fetchAddonsPayfone: + value: + caller_name: null + country_code: US + phone_number: '+16502530000' + national_format: (650) 253-0000 + carrier: + mobile_country_code: null + mobile_network_code: null + name: Level 3 Communications, LLC + type: landline + error_code: null + fraud: null + add_ons: + status: successful + message: null + code: null + results: + payfone_tcpa_compliance: + status: successful + request_sid: XRd3a2991c9108bde3ca9589ed84d31463 + message: null + code: null + result: + Status: 0 + Response: + MSISDNType: NonFixedVoIP + NumberMatch: I + VerifyNumberTransactionId: '2019459819' + RequestId: XRd3a2991c9108bde3ca9589ed84d31463 + Description: Success. + url: https://lookups.twilio.com/v1/PhoneNumbers/+16502530000 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - GA servers: - url: https://lookups.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index a0281e5f..143561b2 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: lookups.v2.phone_number: type: object @@ -61,6 +65,11 @@ components: description: An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources + reassigned_number: + nullable: true + description: An object that contains reassigned number information. Reassigned + Numbers will return a phone number's reassignment status given a phone + number and date sms_pumping_risk: nullable: true description: An object that contains information on if a phone number has @@ -87,10 +96,6 @@ components: - INVALID_COUNTRY_CODE - INVALID_LENGTH - NOT_A_NUMBER - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Lookups description: This is the public Twilio REST API. @@ -102,7 +107,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: @@ -132,9 +137,40 @@ paths: in: query description: A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, - identity_match. + identity_match, reassigned_number. schema: type: string + examples: + fetchCallerName: + value: caller_name + fetchSimSwap: + value: sim_swap + fetchSimSwapWithoutLastSimSwapDate: + value: sim_swap + fetchSimSwapWithFalseSwapped: + value: sim_swap + fetchCallForwarding: + value: call_forwarding + fetchSimSwapAndCallForwarding: + value: sim_swap,call_forwarding + fetchLiveActivityConnectivity: + value: live_activity + fetchLiveActivityPorting: + value: live_activity + fetchLiveActivityRoaming: + value: live_activity + fetchLineTypeIntelligence: + value: line_type_intelligence + fetchIdentityMatch: + value: identity_match + fetchSmsPumpingRisk: + value: sms_pumping_risk + fetchReassignedNumberWithNumberReassigned: + value: reassigned_number + fetchReassignedNumberWithNumberNoReassigned: + value: reassigned_number + fetchReassignedNumberWithNoDataAvailable: + value: reassigned_number - name: CountryCode in: query description: The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -147,30 +183,45 @@ paths: \ for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: John - name: LastName in: query description: "User\u2019s last name. This query parameter is only used (optionally)\ \ for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: Doe - name: AddressLine1 in: query description: "User\u2019s first address line. This query parameter is only\ \ used (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: 321 Main Street - name: AddressLine2 in: query description: "User\u2019s second address line. This query parameter is only\ \ used (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: Suite 2 - name: City in: query description: "User\u2019s city. This query parameter is only used (optionally)\ \ for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: New York - name: State in: query description: "User\u2019s country subdivision, such as state, province, or\ @@ -178,12 +229,18 @@ paths: \ package requests." schema: type: string + examples: + fetchIdentityMatch: + value: NY - name: PostalCode in: query description: "User\u2019s postal zip code. This query parameter is only used\ \ (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: '10021' - name: AddressCountryCode in: query description: "User\u2019s country, up to two characters. This query parameter\ @@ -191,33 +248,461 @@ paths: schema: type: string format: iso-country-code + examples: + fetchIdentityMatch: + value: US - name: NationalId in: query description: "User\u2019s national ID, such as SSN or Passport ID. This query\ \ parameter is only used (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: YZ3456883 - name: DateOfBirth in: query description: "User\u2019s date of birth, in YYYYMMDD format. This query parameter\ \ is only used (optionally) for identity_match package requests." schema: type: string + examples: + fetchIdentityMatch: + value: '19901214' + - name: LastVerifiedDate + in: query + description: The date you obtained consent to call or text the end-user of + the phone number or a date on which you are reasonably certain that the + end-user could still be reached at that number. This query parameter is + only used (optionally) for reassigned_number package requests. + schema: + type: string + examples: + fetchReassignedNumberWithNumberReassigned: + value: '20201227' + fetchReassignedNumberWithNumberNoReassigned: + value: '20190924' + fetchReassignedNumberWithNoDataAvailable: + value: '20211224' responses: '200': content: application/json: schema: $ref: '#/components/schemas/lookups.v2.phone_number' + examples: + fetch: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchInvalid: + value: + calling_country_code: null + country_code: null + phone_number: '+141599299600' + national_format: null + valid: false + validation_errors: + - TOO_LONG + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+141599299600 + fetchCallerName: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: null + caller_name: + caller_name: Sergio Suarez + caller_type: CONSUMER + error_code: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchSimSwap: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: + last_sim_swap: + last_sim_swap_date: '2020-04-27T10:18:50Z' + swapped_period: PT15282H33M44S + swapped_in_period: true + carrier_name: Vodafone UK + mobile_country_code: '276' + mobile_network_code: '02' + error_code: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchSimSwapWithoutLastSimSwapDate: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: + last_sim_swap: + last_sim_swap_date: null + swapped_period: PT24H + swapped_in_period: true + carrier_name: Vodafone UK + mobile_country_code: '276' + mobile_network_code: '02' + error_code: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchSimSwapWithFalseSwapped: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: + last_sim_swap: + last_sim_swap_date: null + swapped_period: PT24H + swapped_in_period: false + carrier_name: Vodafone UK + mobile_country_code: '276' + mobile_network_code: '02' + error_code: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchCallForwarding: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: + call_forwarding_status: 'true' + carrier_name: Vodafone UK + mobile_country_code: '276' + mobile_network_code: '02' + error_code: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchSimSwapAndCallForwarding: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: + last_sim_swap: + last_sim_swap_date: '2020-11-05T20:52:09.322Z' + swapped_period: PT24H + swapped_in_period: true + carrier_name: Vodafone UK + mobile_country_code: '276' + mobile_network_code: '02' + error_code: null + call_forwarding: + call_forwarding_status: 'true' + carrier_name: Vodafone UK + mobile_country_code: '276' + mobile_network_code: '02' + error_code: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchLiveActivityConnectivity: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: + connectivity: connected + original_carrier: + name: Vodafone + mobile_country_code: '234' + mobile_network_code: '15' + ported: 'false' + ported_carrier: null + roaming: 'false' + roaming_carrier: null + error_code: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchLiveActivityPorting: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: + connectivity: connected + original_carrier: + name: Vodafone + mobile_country_code: '234' + mobile_network_code: '15' + ported: 'true' + ported_carrier: + name: Orange + mobile_country_code: '266' + mobile_network_code: '10' + roaming: 'false' + roaming_carrier: null + error_code: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchLiveActivityRoaming: + value: + calling_country_code: '44' + country_code: GB + phone_number: '+447772000001' + national_format: 07772 000001 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: + connectivity: connected + original_carrier: + name: Vodafone + mobile_country_code: '234' + mobile_network_code: '15' + ported: 'false' + ported_carrier: null + roaming: 'true' + roaming_carrier: + name: Orange + mobile_country_code: '266' + mobile_network_code: '10' + country_code: RO + error_code: null + line_type_intelligence: null + identity_match: null + sms_pumping_risk: null + reassigned_number: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+447772000001 + fetchLineTypeIntelligence: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: null + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: + error_code: null + mobile_country_code: '240' + mobile_network_code: '38' + carrier_name: Twilio - SMS/MMS-SVR + type: nonFixedVoip + identity_match: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchIdentityMatch: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: [] + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: + first_name_match: exact_match + last_name_match: high_partial_match + address_lines_match: no_match + city_match: no_match + state_match: high_partial_match + postal_code_match: no_data_available + address_country_match: exact_match + national_id_match: exact_match + date_of_birth_match: exact_match + summary_score: 90 + error_code: null + error_message: null + reassigned_number: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchSmsPumpingRisk: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: [] + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: null + sms_pumping_risk: + carrier: + name: Twilio Carrier + mobile_country_code: '214' + mobile_network_code: '07' + carrier_risk_score: 69 + carrier_risk_category: moderate + number_blocked: false + number_blocked_date: null + number_blocked_last_3_months: null + sms_pumping_risk_score: 61 + error_code: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchReassignedNumberWithNumberReassigned: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: [] + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + reassigned_number: + last_verified_date: '2020-12-27' + is_number_reassigned: 'yes' + error_code: null + identity_match: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchReassignedNumberWithNumberNoReassigned: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: [] + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: + last_verified_date: '2019-09-24' + is_number_reassigned: 'no' + error_code: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 + fetchReassignedNumberWithNoDataAvailable: + value: + calling_country_code: '1' + country_code: US + phone_number: '+14159929960' + national_format: (415) 992-9960 + valid: true + validation_errors: [] + caller_name: null + sim_swap: null + call_forwarding: null + live_activity: null + line_type_intelligence: null + identity_match: null + reassigned_number: + last_verified_date: '2021-12-24' + is_number_reassigned: no_data_available + error_code: null + sms_pumping_risk: null + url: https://lookups.twilio.com/v2/PhoneNumbers/+14159929960 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - Beta servers: - url: https://lookups.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index 3280a8c0..6f01815b 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: media.v1.media_processor: type: object @@ -368,10 +372,25 @@ components: nullable: true description: The grant that authorizes the player sdk to connect to the livestream - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + transcription_enum_status: + type: string + enum: + - completed + - deleted + - enqueued + - failed + - processing + transcription_configuration_enum_method: + type: string + enum: + - get + - post + transcription_result_enum_format: + type: string + enum: + - json + - raw + - txt info: title: Twilio - Media description: This is the public Twilio REST API. @@ -383,7 +402,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/MediaProcessors: @@ -397,8 +416,8 @@ paths: - status - extension - extension_context - pathType: list mountName: media_processor + pathType: list post: description: '' responses: @@ -407,12 +426,25 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_processor' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: started + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: Created security: - accountSid_authToken: [] operationId: CreateMediaProcessor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -464,6 +496,15 @@ paths: required: - Extension - ExtensionContext + examples: + create: + value: + Extension: video-composer-v2 + ExtensionContext: '{}' + ExtensionEnvironment: '{}' + StatusCallback: http://www.example.com + StatusCallbackMethod: POST + MaxDuration: 300 get: description: Returns a list of MediaProcessors. parameters: @@ -474,6 +515,15 @@ paths: schema: type: string $ref: '#/components/schemas/media_processor_enum_order' + examples: + readEmpty: + value: asc + readItems: + value: desc + readItemsUsingPageToken: + value: desc + readItemsPageLargerThanMax: + value: desc - name: Status in: query description: Status to filter by, with possible values `started`, `ended` @@ -481,6 +531,15 @@ paths: schema: type: string $ref: '#/components/schemas/media_processor_enum_status' + examples: + readEmpty: + value: started + readItems: + value: ended + readItemsUsingPageToken: + value: ended + readItemsPageLargerThanMax: + value: ended - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -513,34 +572,113 @@ paths: items: $ref: '#/components/schemas/media.v1.media_processor' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=started&Order=asc&PageSize=10&Page=0 + next_page_url: null + key: media_processors + media_processors: [] + readItems: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0 + next_page_url: null + key: media_processors + media_processors: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 + readItemsUsingPageToken: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=10&Page=0&PageToken=PTTUszYTgyOGFhNDIzZWExNzA0OTkwODNlMDlkZTg3M2NiNDoxOjI%253D + next_page_url: null + key: media_processors + media_processors: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 + readItemsPageLargerThanMax: + value: + meta: + page: 0 + page_size: 100 + first_page_url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaProcessors?Status=ended&Order=desc&PageSize=100&Page=0 + next_page_url: null + key: media_processors + media_processors: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: OK security: - accountSid_authToken: [] operationId: ListMediaProcessor - x-maturity: - - GA /v1/MediaProcessors/{Sid}: servers: - url: https://media.twilio.com @@ -552,8 +690,8 @@ paths: - status - extension - extension_context - pathType: instance mountName: media_processor + pathType: instance get: description: Returns a single MediaProcessor resource identified by a SID. parameters: @@ -572,12 +710,25 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_processor' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: started + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: OK security: - accountSid_authToken: [] operationId: FetchMediaProcessor - x-maturity: - - GA post: description: Updates a MediaProcessor resource identified by a SID. parameters: @@ -596,12 +747,25 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_processor' + examples: + updateEnded: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + extension: video-composer-v2 + extension_context: '{}' + sid: ZXdeadbeefdeadbeefdeadbeefdeadbeef + status: ended + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/MediaProcessors/ZXdeadbeefdeadbeefdeadbeefdeadbeef + max_duration: 300 description: OK security: - accountSid_authToken: [] operationId: UpdateMediaProcessor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -615,6 +779,10 @@ paths: description: The status of the MediaProcessor. Can be `ended`. required: - Status + examples: + updateEnded: + value: + Status: ended /v1/MediaRecordings/{Sid}: servers: - url: https://media.twilio.com @@ -624,11 +792,11 @@ paths: defaultOutputProperties: - sid - status - pathType: instance dependentProperties: - media/v1/media_recording_timed_metadata: '{media_recording_sid: sid}' - media/v1/media_recording_media: '{media_recording_sid: sid}' + recording_timed_metadata: '{media_recording_sid: sid}' + media_recording_media: '{media_recording_sid: sid}' mountName: media_recording + pathType: instance delete: description: Deletes a MediaRecording resource identified by a SID. parameters: @@ -647,8 +815,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMediaRecording - x-maturity: - - Preview get: description: Returns a single MediaRecording resource identified by a SID. parameters: @@ -667,12 +833,30 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.media_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + duration: 2147483647 + format: mp4 + links: + media: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media + timed_metadata: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata + processor_sid: ZXcafebabecafebabecafebabecafebabe + resolution: 640x480 + source_sid: RMcafebabecafebabecafebabecafebabe + sid: KVcafebabecafebabecafebabecafebabe + media_size: 2147483648 + status: completed + status_callback: https://www.example.com + status_callback_method: POST + url: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe description: OK security: - accountSid_authToken: [] operationId: FetchMediaRecording - x-maturity: - - Preview /v1/MediaRecordings: servers: - url: https://media.twilio.com @@ -682,11 +866,11 @@ paths: defaultOutputProperties: - sid - status - pathType: list dependentProperties: - media/v1/media_recording_timed_metadata: '{media_recording_sid: sid}' - media/v1/media_recording_media: '{media_recording_sid: sid}' + recording_timed_metadata: '{media_recording_sid: sid}' + media_recording_media: '{media_recording_sid: sid}' mountName: media_recording + pathType: list get: description: Returns a list of MediaRecordings. parameters: @@ -697,6 +881,11 @@ paths: schema: type: string $ref: '#/components/schemas/media_recording_enum_order' + examples: + readEmpty: + value: asc + readItems: + value: desc - name: Status in: query description: Status to filter by, with possible values `processing`, `completed`, @@ -704,6 +893,11 @@ paths: schema: type: string $ref: '#/components/schemas/media_recording_enum_status' + examples: + readEmpty: + value: processing + readItems: + value: completed - name: ProcessorSid in: query description: SID of a MediaProcessor to filter by. @@ -712,6 +906,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^ZX[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readItems: + value: ZXcafebabecafebabecafebabecafebabe - name: SourceSid in: query description: SID of a MediaRecording source to filter by. @@ -720,6 +919,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readItems: + value: RMcafebabecafebabecafebabecafebabe - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -752,34 +956,72 @@ paths: items: $ref: '#/components/schemas/media.v1.media_recording' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaRecordings?Status=processing&SourceSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ProcessorSid=ZXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Order=asc&PageSize=10&Page=0 + next_page_url: null + key: media_recordings + media_recordings: [] + readItems: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/MediaRecordings?Status=completed&SourceSid=RMcafebabecafebabecafebabecafebabe&ProcessorSid=ZXcafebabecafebabecafebabecafebabe&Order=desc&PageSize=10&Page=0 + next_page_url: null + key: media_recordings + media_recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + duration: 1000 + format: mp4 + links: + media: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/Media + timed_metadata: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe/TimedMetadata + processor_sid: ZXcafebabecafebabecafebabecafebabe + resolution: 640x480 + source_sid: RMcafebabecafebabecafebabecafebabe + sid: KVcafebabecafebabecafebabecafebabe + media_size: 1000 + status: completed + status_callback: https://www.example.com + status_callback_method: POST + url: https://media.twilio.com/v1/MediaRecordings/KVcafebabecafebabecafebabecafebabe description: OK security: - accountSid_authToken: [] operationId: ListMediaRecording - x-maturity: - - Preview /v1/PlayerStreamers/{Sid}: servers: - url: https://media.twilio.com @@ -789,12 +1031,12 @@ paths: defaultOutputProperties: - sid - status - pathType: instance dependentProperties: - media/v1/player_streamer_timed_metadata: '{player_streamer_sid: sid}' + timed_metadata: '{player_streamer_sid: sid}' playback_grant: '{sid: sid}' - media/v1/player_streamer_recording_playback_grant: '{sid: sid}' + recording_playback_grant: '{sid: sid}' mountName: player_streamer + pathType: instance get: description: Returns a single PlayerStreamer resource identified by a SID. parameters: @@ -813,12 +1055,27 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: created + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: OK security: - accountSid_authToken: [] operationId: FetchPlayerStreamer - x-maturity: - - GA post: description: Updates a PlayerStreamer resource identified by a SID. parameters: @@ -837,12 +1094,27 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + status: ended + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: OK security: - accountSid_authToken: [] operationId: UpdatePlayerStreamer - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -857,6 +1129,10 @@ paths: to. Can be: `ended`.' required: - Status + examples: + update: + value: + Status: ended /v1/PlayerStreamers: servers: - url: https://media.twilio.com @@ -866,12 +1142,12 @@ paths: defaultOutputProperties: - sid - status - pathType: list dependentProperties: - media/v1/player_streamer_timed_metadata: '{player_streamer_sid: sid}' + timed_metadata: '{player_streamer_sid: sid}' playback_grant: '{sid: sid}' - media/v1/player_streamer_recording_playback_grant: '{sid: sid}' + recording_playback_grant: '{sid: sid}' mountName: player_streamer + pathType: list post: description: '' responses: @@ -880,12 +1156,27 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: created + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: null + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: Created security: - accountSid_authToken: [] operationId: CreatePlayerStreamer - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -922,6 +1213,9 @@ paths: The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming. + examples: + create: + value: {} get: description: Returns a list of PlayerStreamers. parameters: @@ -932,6 +1226,13 @@ paths: schema: type: string $ref: '#/components/schemas/player_streamer_enum_order' + examples: + readEmpty: + value: asc + readItems: + value: desc + readItemsPageLargerThanMax: + value: desc - name: Status in: query description: Status to filter by, with possible values `created`, `started`, @@ -939,6 +1240,13 @@ paths: schema: type: string $ref: '#/components/schemas/player_streamer_enum_status' + examples: + readEmpty: + value: started + readItems: + value: ended + readItemsPageLargerThanMax: + value: ended - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -971,34 +1279,94 @@ paths: items: $ref: '#/components/schemas/media.v1.player_streamer' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/PlayerStreamers?Status=started&Order=asc&PageSize=10&Page=0 + next_page_url: null + key: player_streamers + player_streamers: [] + readItems: + value: + meta: + page: 0 + page_size: 10 + first_page_url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=10&Page=0 + next_page_url: null + key: player_streamers + player_streamers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + status: ended + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant + readItemsPageLargerThanMax: + value: + meta: + page: 0 + page_size: 100 + first_page_url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0 + previous_page_url: null + url: https://media.twilio.com/v1/PlayerStreamers?Status=ended&Order=desc&PageSize=100&Page=0 + next_page_url: null + key: player_streamers + player_streamers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:00Z' + status: ended + video: true + sid: VJcafebabecafebabecafebabecafebabe + status_callback: http://www.example.com + status_callback_method: POST + ended_reason: ended-via-api + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe + max_duration: 300 + links: + timed_metadata: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/TimedMetadata + playback_grant: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant description: OK security: - accountSid_authToken: [] operationId: ListPlayerStreamer - x-maturity: - - GA /v1/PlayerStreamers/{Sid}/PlaybackGrant: servers: - url: https://media.twilio.com @@ -1006,8 +1374,8 @@ paths: initialize the Twilio Live Player SDK and connect to a livestream. x-twilio: defaultOutputProperties: [] - pathType: instance parent: /PlayerStreamers/{Sid} + pathType: instance post: description: '' parameters: @@ -1027,12 +1395,21 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant' + examples: + create: + value: + sid: VJcafebabecafebabecafebabecafebabe + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + grant: + playbackUrl: http://video.net/123/blabla?token=123 + playerStreamerSid: VJcafebabecafebabecafebabecafebabe + requestCredentials: null description: Created security: - accountSid_authToken: [] operationId: CreatePlayerStreamerPlaybackGrant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1048,6 +1425,11 @@ paths: type: string description: The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain. + examples: + create: + value: + Ttl: 100 + AccessControlAllowOrigin: youraccess_control_allow_origin.com get: description: '**This method is not enabled.** Returns a single PlaybackGrant resource identified by a SID.' @@ -1067,18 +1449,20 @@ paths: application/json: schema: $ref: '#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + url: https://media.twilio.com/v1/PlayerStreamers/VJcafebabecafebabecafebabecafebabe/PlaybackGrant + sid: VJcafebabecafebabecafebabecafebabe + grant: + playbackUrl: http://video.net/123/blabla?token=123 + playerStreamerSid: VJcafebabecafebabecafebabecafebabe + requestCredentials: null description: OK security: - accountSid_authToken: [] operationId: FetchPlayerStreamerPlaybackGrant - x-maturity: - - GA servers: - url: https://media.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_messaging_bulk_v1.yaml b/spec/yaml/twilio_messaging_bulk_v1.yaml new file mode 100644 index 00000000..53abeb74 --- /dev/null +++ b/spec/yaml/twilio_messaging_bulk_v1.yaml @@ -0,0 +1,265 @@ +openapi: 3.0.3 +info: + title: Bulk Messaging API + description: This is the public Twilio REST API for 1:Many Message creation. + termsOfService: https://www.twilio.com/legal/tos + version: 1.0.0-alpha.1 + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html +servers: +- url: https://preview.messaging.twilio.com +paths: + /v1/Messages: + post: + description: Send messages to multiple recipients + operationId: CreateMessages + requestBody: + required: true + content: + application/json: + schema: + type: object + title: CreateMessagesRequest + properties: + Messages: + type: array + items: + $ref: '#/components/schemas/messaging.v1.Message' + From: + type: string + format: phone-number + description: A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), + or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) + that is enabled for the type of message you want to send. Phone + numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) + purchased from Twilio also work here. You cannot, for example, + spoof messages from a private cell phone number. If you are using + `messaging_service_sid`, this parameter must be empty. + MessagingServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) + you want to associate with the Message. Set this parameter to + use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) + you have configured and leave the `from` parameter empty. When + only this parameter is set, Twilio will use your enabled Copilot + Features to select the `from` phone number for delivery. + Body: + type: string + description: The text of the message you want to send. Can be up + to 1,600 characters in length. + ContentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + description: The SID of the preconfigured [Content Template](https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template) + you want to associate with the Message. Must be used in conjuction + with a preconfigured [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) + When this parameter is set, Twilio will use your configured content + template and the provided `ContentVariables`. This Twilio product + is currently in Private Beta. + MediaUrl: + type: array + items: + type: string + format: uri + description: The URL of the media to send with the message. The + media can be of type `gif`, `png`, and `jpeg` and will be formatted + correctly on the recipient's device. The media size limit is 5MB + for supported file types (JPEG, PNG, GIF) and 500KB for [other + types](https://www.twilio.com/docs/sms/accepted-mime-types) of + accepted media. To send more than one image in the message body, + provide multiple `media_url` parameters in the POST request. You + can include up to 10 `media_url` parameters per message. You can + send images in an SMS message in only the US and Canada. + StatusCallback: + type: string + format: uri + description: The URL we should call using the "status_callback_method" + to send status information to your application. If specified, + we POST these message status changes to the URL - queued, failed, + sent, delivered, or undelivered. Twilio will POST its [standard + request parameters](https://www.twilio.com/docs/messaging/twiml#request-parameters) + as well as some additional parameters including "MessageSid", + "MessageStatus", and "ErrorCode". If you include this parameter + with the "messaging_service_sid", we use this URL instead of the + Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api). + URLs must contain a valid hostname and underscores are not allowed. + ValidityPeriod: + type: integer + description: How long in seconds the message can remain in our outgoing + message queue. After this period elapses, the message fails and + we call your status callback. Can be between 1 and the default + value of 14,400 seconds. After a message has been accepted by + a carrier, however, we cannot guarantee that the message will + not be queued after this period. We recommend that this value + be at least 5 seconds. + SendAt: + type: string + description: The time at which Twilio will send the message. This + parameter can be used to schedule a message to be sent at a particular + time. Must be in ISO 8601 format. + ScheduleType: + type: string + description: This parameter indicates your intent to schedule a + message. Pass the value `fixed` to schedule a message at a fixed + time. This parameter works in conjuction with the `SendAt` parameter. + ShortenUrls: + type: boolean + description: Determines the usage of Click Tracking. Setting it + to `true` will instruct Twilio to replace all links in the Message + with a shortened version based on the associated Domain Sid and + track clicks on them. If this parameter is not set on an API call, + we will use the value set on the Messaging Service. If this parameter + is not set and the value is not configured on the Messaging Service + used this will default to `false`. + SendAsMms: + type: boolean + description: If set to True, Twilio will deliver the message as + a single MMS message, regardless of the presence of media. + MaxPrice: + type: number + description: The maximum total price in US dollars that you will + pay for the message to be delivered. Can be a decimal value that + has up to 4 decimal places. All messages are queued for delivery + and the message cost is checked before the message is sent. If + the cost exceeds max_price, the message will fail and a status + of Failed is sent to the status callback. If MaxPrice is not set, + the message cost is not checked. + Attempt: + type: integer + description: Total number of attempts made ( including this ) to + send out the message regardless of the provider used + SmartEncoded: + type: boolean + description: This parameter indicates whether to detect Unicode + characters that have a similar GSM-7 character and replace them. + Can be true or false. + ForceDelivery: + type: boolean + description: This parameter allows Twilio to send SMS traffic to + carriers without checking/caring whether the destination number + is a mobile or a landline. + ApplicationSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + description: The SID of the application that should receive message + status. We POST a message_sid parameter and a message_status parameter + with a value of sent or failed to the application's message_status_callback. + If a status_callback parameter is also passed, it will be ignored + and the application's message_status_callback parameter will be + used. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.CreateMessagesResult' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.Error' + security: + - accountSid_authToken: [] +components: + schemas: + messaging.v1.Message: + type: object + properties: + To: + type: string + format: phone-number + description: The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) + format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) + for other 3rd-party channels. + Body: + type: string + description: The text of the message you want to send. Can be up to 1,600 + characters in length. Overrides the request-level body and content template + if provided. + ContentVariables: + type: object + additionalProperties: + type: string + description: Key-value pairs of variable names to substitution values. Refer + to the [Twilio Content API Resources](https://www.twilio.com/docs/content-api/content-api-resources#send-a-message-with-preconfigured-content) + for more details. + messaging.v1.MessageReceipt: + type: object + properties: + to: + type: string + nullable: true + description: The recipient phone number + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^(SM|MM)[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that identifies the resource + messaging.v1.FailedMessageReceipt: + type: object + properties: + to: + type: string + description: The recipient phone number + error_message: + type: string + description: The description of the error_code + error_code: + type: integer + description: The error code associated with the message creation attempt + messaging.v1.CreateMessagesResult: + properties: + total_message_count: + type: integer + description: The number of Messages processed in the request, equal to the + sum of success_count and error_count. + success_count: + type: integer + description: The number of Messages successfully created. + error_count: + type: integer + description: The number of Messages unsuccessfully processed in the request. + message_receipts: + type: array + items: + $ref: '#/components/schemas/messaging.v1.MessageReceipt' + failed_message_receipts: + type: array + items: + $ref: '#/components/schemas/messaging.v1.FailedMessageReceipt' + messaging.v1.Error: + type: object + properties: + message: + type: string + description: The error message details + code: + type: integer + description: The Twilio error code + status: + type: integer + description: The HTTP status code + more_info: + type: string + description: More information on the error + securitySchemes: + accountSid_authToken: + type: http + scheme: basic diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index e4bb5b2f..57aa5f02 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: messaging.v1.service.alpha_sender: type: object @@ -823,6 +827,21 @@ components: format: uri nullable: true description: The absolute URL of the ShortCode resource. + tollfree_verification_enum_status: + type: string + enum: + - PENDING_REVIEW + - IN_REVIEW + - TWILIO_APPROVED + - TWILIO_REJECTED + tollfree_verification_enum_opt_in_type: + type: string + enum: + - VERBAL + - WEB_FORM + - PAPER_FORM + - VIA_TEXT + - MOBILE_QR_CODE messaging.v1.service.us_app_to_person: type: object properties: @@ -1017,10 +1036,33 @@ components: nullable: true description: Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + whatsapp_sender_enum_status: + type: string + enum: + - Configuring + - PendingVerification + - Configured + - ConfigurationError + - VerificationError + whatsapp_template_enum_category: + type: string + enum: + - ACCOUNT_UPDATE + - ALERT_UPDATE + - AUTO_REPLY + - APPOINTMENT_UPDATE + - ISSUE_RESOLUTION + - PAYMENT_UPDATE + - PERSONAL_FINANCE_UPDATE + - RESERVATION_UPDATE + - SHIPPING_UPDATE + - TICKET_UPDATE + - TRANSPORTATION_UPDATE + - MARKETING + - OTP + - TRANSACTIONAL + - AUTHENTICATION + - UTILITY info: title: Twilio - Messaging description: This is the public Twilio REST API. @@ -1032,7 +1074,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/AlphaSenders: @@ -1044,8 +1086,8 @@ paths: defaultOutputProperties: - sid - alpha_sender - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -1065,12 +1107,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' + examples: + create: + value: + sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + alpha_sender: Twilio + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateAlphaSender - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1086,6 +1138,10 @@ paths: contain only numbers. required: - AlphaSender + examples: + create: + value: + AlphaSender: Twilio get: description: '' parameters: @@ -1131,34 +1187,53 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: alpha_senders + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0 + alpha_senders: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + alpha_sender: Twilio + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListAlphaSender - x-maturity: - - Beta /v1/Services/{ServiceSid}/AlphaSenders/{Sid}: servers: - url: https://messaging.twilio.com @@ -1168,8 +1243,8 @@ paths: defaultOutputProperties: - sid - alpha_sender - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -1195,12 +1270,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' + examples: + fetch: + value: + sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + alpha_sender: Twilio + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchAlphaSender - x-maturity: - - Beta delete: description: '' parameters: @@ -1226,8 +1311,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAlphaSender - x-maturity: - - Beta /v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp: servers: - url: https://messaging.twilio.com @@ -1237,9 +1320,9 @@ paths: defaultOutputProperties: - account_sid - brand_registration_sid - pathType: list parent: /a2p/BrandRegistrations/{Sid} mountName: brand_registration_otps + pathType: list post: description: '' parameters: @@ -1258,12 +1341,15 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_registration_otp' + examples: + create: + value: + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_registration_sid: BN0044409f7e067e279523808d267e2d85 description: Created security: - accountSid_authToken: [] operationId: CreateBrandRegistrationOtp - x-maturity: - - Beta /v1/a2p/BrandRegistrations/{Sid}: servers: - url: https://messaging.twilio.com @@ -1272,10 +1358,10 @@ paths: defaultOutputProperties: - sid - date_created - pathType: instance dependentProperties: brand_vetting: '{brand_sid: sid}' brand_registration_otp: '{brand_registration_sid: sid}' + pathType: instance get: description: '' parameters: @@ -1294,12 +1380,133 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' + examples: + fetch: + value: + sid: BN0044409f7e067e279523808d267e2d85 + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: STANDARD + status: PENDING + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: true + government_entity: false + tax_exempt_status: 501c3 + skip_automatic_sec_vet: false + mock: false + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp + fetchSoleProprietorPending: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: PENDING + identity_status: null + brand_type: SOLE_PROPRIETOR + mock: false + tcr_id: null + brand_score: null + russell_3000: null + brand_feedback: null + failure_reason: null + government_entity: null + tax_exempt_status: null + skip_automatic_sec_vet: false + date_updated: '2023-03-15T14:21:42Z' + date_created: '2023-03-15T14:21:42Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp + fetchSoleProprietorRegisteredUnverified: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: APPROVED + identity_status: UNVERIFIED + brand_type: SOLE_PROPRIETOR + mock: false + tcr_id: null + brand_score: null + russell_3000: null + brand_feedback: null + failure_reason: null + government_entity: null + tax_exempt_status: null + skip_automatic_sec_vet: false + date_updated: '2023-03-15T14:21:42Z' + date_created: '2023-03-15T14:21:42Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp + fetchSoleProprietorRegisteredSelfDeclared: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: APPROVED + identity_status: SELF_DECLARED + brand_type: SOLE_PROPRIETOR + mock: false + tcr_id: null + brand_score: null + russell_3000: null + brand_feedback: null + failure_reason: null + government_entity: null + tax_exempt_status: null + skip_automatic_sec_vet: false + date_updated: '2023-03-15T14:21:42Z' + date_created: '2023-03-15T14:21:42Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp + fetchSoleProprietorRegisteredVerified: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: APPROVED + identity_status: VERIFIED + brand_type: SOLE_PROPRIETOR + mock: false + tcr_id: null + brand_score: null + russell_3000: null + brand_feedback: null + failure_reason: null + government_entity: null + tax_exempt_status: null + skip_automatic_sec_vet: false + date_updated: '2023-03-15T14:21:42Z' + date_created: '2023-03-15T14:21:42Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp description: OK security: - accountSid_authToken: [] operationId: FetchBrandRegistrations - x-maturity: - - Beta post: description: '' parameters: @@ -1318,12 +1525,61 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' + examples: + update: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: STANDARD + status: PENDING + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: false + government_entity: false + tax_exempt_status: 501c3 + skip_automatic_sec_vet: false + mock: false + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp + updateSoleProprietorBrand: + value: + sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: SOLE_PROPRIETOR + status: PENDING + tcr_id: BXXXXXX + failure_reason: null + brand_score: null + brand_feedback: null + identity_status: UNVERIFIED + russell_3000: false + government_entity: false + tax_exempt_status: null + skip_automatic_sec_vet: false + mock: false + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp description: Accepted security: - accountSid_authToken: [] operationId: UpdateBrandRegistrations - x-maturity: - - Beta /v1/a2p/BrandRegistrations: servers: - url: https://messaging.twilio.com @@ -1332,10 +1588,10 @@ paths: defaultOutputProperties: - sid - date_created - pathType: list dependentProperties: brand_vetting: '{brand_sid: sid}' brand_registration_otp: '{brand_registration_sid: sid}' + pathType: list get: description: '' parameters: @@ -1371,34 +1627,68 @@ paths: items: $ref: '#/components/schemas/messaging.v1.brand_registrations' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: data + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 + data: + - sid: BN0044409f7e067e279523808d267e2d85 + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:36Z' + brand_type: STANDARD + status: APPROVED + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: true + tax_exempt_status: 501c3 + government_entity: false + skip_automatic_sec_vet: false + mock: false + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp description: OK security: - accountSid_authToken: [] operationId: ListBrandRegistrations - x-maturity: - - Beta post: description: '' responses: @@ -1407,12 +1697,61 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' + examples: + create: + value: + sid: BN0044409f7e067e279523808d267e2d85 + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + customer_profile_bundle_sid: BU0000009f7e067e279523808d267e2d90 + a2p_profile_bundle_sid: BU1111109f7e067e279523808d267e2d85 + date_created: '2021-01-28T10:45:51Z' + date_updated: '2021-01-28T10:45:51Z' + brand_type: STANDARD + status: PENDING + tcr_id: BXXXXXX + failure_reason: Registration error + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 + brand_score: 42 + brand_feedback: + - TAX_ID + - NONPROFIT + identity_status: VERIFIED + russell_3000: true + government_entity: false + tax_exempt_status: 501c3 + skip_automatic_sec_vet: false + mock: false + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp + createSoleProprietorBrand: + value: + sid: BN0044409f7e067e279523808d267e2d85 + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + customer_profile_bundle_sid: BU0000009f7e067e279523808d267e2d90 + a2p_profile_bundle_sid: BU1111109f7e067e279523808d267e2d85 + date_created: '2021-01-28T10:45:51Z' + date_updated: '2021-01-28T10:45:51Z' + brand_type: SOLE_PROPRIETOR + status: PENDING + tcr_id: BXXXXXX + failure_reason: null + brand_score: null + brand_feedback: null + identity_status: UNVERIFIED + russell_3000: false + government_entity: false + tax_exempt_status: null + skip_automatic_sec_vet: false + mock: false + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 + links: + brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings + brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp description: Created security: - accountSid_authToken: [] operationId: CreateBrandRegistrations - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1449,6 +1788,21 @@ paths: required: - CustomerProfileBundleSid - A2PProfileBundleSid + examples: + create: + value: + CustomerProfileBundleSid: BU0000009f7e067e279523808d267e2d90 + A2PProfileBundleSid: BU1111109f7e067e279523808d267e2d85 + BrandType: STANDARD + SkipAutomaticSecVet: false + Mock: false + createSoleProprietorBrand: + value: + CustomerProfileBundleSid: BU0000009f7e067e279523808d267e2d90 + A2PProfileBundleSid: BU1111109f7e067e279523808d267e2d85 + BrandType: STANDARD + SkipAutomaticSecVet: false + Mock: false /v1/a2p/BrandRegistrations/{BrandSid}/Vettings: servers: - url: https://messaging.twilio.com @@ -1462,9 +1816,9 @@ paths: - date_updated - vetting_status - vetting_class - pathType: list parent: /a2p/BrandRegistrations/{Sid} mountName: brand_vettings + pathType: list post: description: '' parameters: @@ -1484,12 +1838,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' + examples: + create: + value: + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_sid: BN0044409f7e067e279523808d267e2d85 + brand_vetting_sid: VT12445353 + vetting_provider: campaign-verify + vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY + vetting_class: POLITICAL + vetting_status: IN_PROGRESS + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:35Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 description: Created security: - accountSid_authToken: [] operationId: CreateBrandVetting - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1507,6 +1872,11 @@ paths: description: The unique ID of the vetting required: - VettingProvider + examples: + create: + value: + VettingProvider: campaign-verify + VettingId: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY get: description: '' parameters: @@ -1558,34 +1928,54 @@ paths: items: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: data + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0 + data: + - account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_sid: BN0044409f7e067e279523808d267e2d85 + brand_vetting_sid: VT12445353 + vetting_provider: campaign-verify + vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY + vetting_class: POLITICAL + vetting_status: IN_PROGRESS + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:35Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 description: OK security: - accountSid_authToken: [] operationId: ListBrandVetting - x-maturity: - - Beta /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}: servers: - url: https://messaging.twilio.com @@ -1599,9 +1989,9 @@ paths: - date_updated - vetting_status - vetting_class - pathType: instance parent: /a2p/BrandRegistrations/{Sid} mountName: brand_vettings + pathType: instance get: description: '' parameters: @@ -1630,12 +2020,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' + examples: + fetch: + value: + account_sid: AC78e8e67fc0246521490fb9907fd0c165 + brand_sid: BN0044409f7e067e279523808d267e2d85 + brand_vetting_sid: VT12445353 + vetting_provider: campaign-verify + vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY + vetting_class: POLITICAL + vetting_status: IN_PROGRESS + date_created: '2021-01-27T14:18:35Z' + date_updated: '2021-01-27T14:18:35Z' + url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 description: OK security: - accountSid_authToken: [] operationId: FetchBrandVetting - x-maturity: - - Beta /v1/Deactivations: servers: - url: https://messaging.twilio.com @@ -1644,8 +2045,8 @@ paths: x-twilio: defaultOutputProperties: - redirect_to - pathType: instance className: deactivations + pathType: instance get: description: Fetch a list of all United States numbers that have been deactivated on a specific date. @@ -1664,16 +2065,18 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.deactivation' + examples: + fetch: + value: + redirect_to: https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com description: Temporary Redirect security: - accountSid_authToken: [] operationId: FetchDeactivation - x-maturity: - - GA /v1/LinkShortening/Domains/{DomainSid}/Certificate: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - certificate_sid @@ -1683,9 +2086,9 @@ paths: - date_created - date_updated - url - pathType: instance mountName: domain_certs className: domain_certs + pathType: instance post: description: '' parameters: @@ -1705,18 +2108,42 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' + examples: + update: + value: + certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: https://api.example.com + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_expires: '2021-02-06T18:02:04Z' + date_created: '2021-02-06T18:02:04Z' + date_updated: '2021-02-06T18:02:04Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate + cert_in_validation: + date_expires: '2021-02-06T18:02:04Z' + status: pending description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' + examples: + create: + value: + certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: https://api.example.com + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_expires: null + date_created: '2021-02-06T18:02:04Z' + date_updated: '2021-02-06T18:02:04Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate + cert_in_validation: + date_expires: '2021-02-06T18:02:04Z' + status: pending description: Created security: - accountSid_authToken: [] operationId: UpdateDomainCertV4 - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1732,6 +2159,119 @@ paths: your domain.' required: - TlsCert + examples: + update: + value: + TlsCert: '-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END + CERTIFICATE----------BEGIN PRIVATE KEY----- + + MIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV + + 80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A + + p1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP + + k0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R + + ZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX + + G2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h + + KSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6 + + n6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU + + 9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq + + 3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh + + TOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft + + Btm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR + + /B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY + + /77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig + + SIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx + + 4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG + + SLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4 + + FBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8 + + ShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg + + NsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx + + 9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz + + FlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM + + 7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv + + syI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ + + 9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q== + + -----END PRIVATE KEY-----' + create: + value: + TlsCert: '-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END + CERTIFICATE----------BEGIN PRIVATE KEY----- + + MIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV + + 80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A + + p1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP + + k0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R + + ZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX + + G2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h + + KSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6 + + n6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU + + 9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq + + 3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh + + TOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft + + Btm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR + + /B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY + + /77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig + + SIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx + + 4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG + + SLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4 + + FBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8 + + ShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg + + NsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx + + 9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz + + FlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM + + 7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv + + syI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ + + 9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q== + + -----END PRIVATE KEY-----' get: description: '' parameters: @@ -1751,12 +2291,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' + examples: + fetch: + value: + certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: https://api.example.com + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_expires: '2021-02-06T18:02:04Z' + date_created: '2021-02-06T18:02:04Z' + date_updated: '2021-02-06T18:02:04Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate + cert_in_validation: + date_expires: '2021-02-06T18:02:04Z' + status: pending description: OK security: - accountSid_authToken: [] operationId: FetchDomainCertV4 - x-maturity: - - Beta delete: description: '' parameters: @@ -1776,12 +2327,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDomainCertV4 - x-maturity: - - Beta /v1/LinkShortening/Domains/{DomainSid}/Config: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - config_sid @@ -1792,8 +2341,8 @@ paths: - date_updated - url - disable_https - pathType: instance mountName: domain_config + pathType: instance post: description: '' parameters: @@ -1813,18 +2362,40 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' + examples: + update: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config + disable_https: false description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' + examples: + create: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config + disable_https: false description: Created security: - accountSid_authToken: [] operationId: UpdateDomainConfig - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1855,6 +2426,19 @@ paths: with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified. + examples: + update: + value: + FallbackUrl: https://www.example.com + CallbackUrl: https://www.example.com + ContinueOnFailure: true + DisableHttps: false + create: + value: + FallbackUrl: https://www.example.com + CallbackUrl: https://www.example.com + DisableHttps: false + ContinueOnFailure: true get: description: '' parameters: @@ -1874,16 +2458,26 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' + examples: + fetch: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config + disable_https: false description: OK security: - accountSid_authToken: [] operationId: FetchDomainConfig - x-maturity: - - Beta /v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - domain_sid @@ -1895,8 +2489,8 @@ paths: - date_updated - url - messaging_service_sid - pathType: instance mountName: domain_config_messaging_service + pathType: instance get: description: '' parameters: @@ -1916,12 +2510,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config_messaging_service' + examples: + fetch: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fallback_url: https://www.example.com + callback_url: https://www.example.com + continue_on_failure: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://messaging.twilio.com/v1/LinkShortening/MessagingService/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DomainConfig + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchDomainConfigMessagingService - x-maturity: - - Beta /v1/Services/PreregisteredUsa2p: servers: - url: https://messaging.twilio.com @@ -1930,8 +2534,8 @@ paths: defaultOutputProperties: - campaign_id - messaging_service_sid - pathType: list mountName: external_campaign + pathType: list post: description: '' responses: @@ -1940,12 +2544,18 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.external_campaign' + examples: + create: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + campaign_id: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-03-21T21:31:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateExternalCampaign - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1966,17 +2576,22 @@ paths: required: - CampaignId - MessagingServiceSid + examples: + create: + value: + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CampaignId: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - messaging_service_sid - domain_sid - url - pathType: instance mountName: linkshortening_messaging_service + pathType: instance post: description: '' parameters: @@ -2008,12 +2623,16 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.linkshortening_messaging_service' + examples: + create: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateLinkshorteningMessagingService - x-maturity: - - Beta delete: description: '' parameters: @@ -2045,19 +2664,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteLinkshorteningMessagingService - x-maturity: - - Beta /v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain: servers: - url: https://messaging.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - domain_sid - messaging_service_sid - url - pathType: instance mountName: linkshortening_messaging_service_domain_association + pathType: instance get: description: '' parameters: @@ -2077,12 +2694,16 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.linkshortening_messaging_service_domain_association' + examples: + fetch: + value: + domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://messaging.twilio.com/v1/LinkShortening/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Domain description: OK security: - accountSid_authToken: [] operationId: FetchLinkshorteningMessagingServiceDomainAssociation - x-maturity: - - Beta /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://messaging.twilio.com @@ -2093,8 +2714,8 @@ paths: - sid - phone_number - country_code - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -2114,12 +2735,36 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' + examples: + create: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '+987654321' + country_code: US + capabilities: [] + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithCapabilities: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '+987654321' + country_code: US + capabilities: + - MMS + - SMS + - Voice + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2135,6 +2780,13 @@ paths: description: The SID of the Phone Number being added to the Service. required: - PhoneNumberSid + examples: + create: + value: + PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithCapabilities: + value: + PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -2180,34 +2832,53 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.phone_number' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: phone_numbers + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '+987654321' + country_code: US + capabilities: [] + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber - x-maturity: - - Beta /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://messaging.twilio.com @@ -2218,8 +2889,8 @@ paths: - sid - phone_number - country_code - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: '' parameters: @@ -2245,8 +2916,6 @@ paths: security: - accountSid_authToken: [] operationId: DeletePhoneNumber - x-maturity: - - Beta get: description: '' parameters: @@ -2272,12 +2941,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + phone_number: '12345' + country_code: US + capabilities: [] + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - Beta /v1/Services: servers: - url: https://messaging.twilio.com @@ -2288,14 +2967,14 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: phone_number: '{service_sid: sid}' short_code: '{service_sid: sid}' alpha_sender: '{service_sid: sid}' - messaging/v1/message: '{messaging_service_sid: sid}' + message: '{messaging_service_sid: sid}' us_app_to_person: '{messaging_service_sid: sid}' us_app_to_person_usecase: '{messaging_service_sid: sid}' + pathType: list post: description: '' responses: @@ -2304,12 +2983,42 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + friendly_name: My Service! + inbound_request_url: https://www.example.com/ + inbound_method: POST + fallback_url: https://www.example.com + fallback_method: GET + status_callback: https://www.example.com + sticky_sender: true + smart_encoding: false + mms_converter: true + fallback_to_long_code: true + scan_message_content: inherit + area_code_geomatch: true + validity_period: 600 + synchronous_validation: true + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: true + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2415,6 +3124,25 @@ paths: defined for the Messaging Service. required: - FriendlyName + examples: + create: + value: + FriendlyName: My Service! + StickySender: true + MmsConverter: true + SmartEncoding: false + FallbackToLongCode: true + InboundRequestUrl: https://www.example.com + InboundMethod: POST + FallbackMethod: GET + FallbackUrl: https://www.example.com + StatusCallback: https://www.example.com + ScanMessageContent: inherit + AreaCodeGeomatch: true + ValidityPeriod: 600 + SynchronousValidation: true + Usecase: marketing + UseInboundWebhookOnNumber: true get: description: '' parameters: @@ -2450,34 +3178,73 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: services + url: https://messaging.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My Service! + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + sticky_sender: true + mms_converter: true + smart_encoding: false + fallback_to_long_code: true + area_code_geomatch: true + validity_period: 600 + scan_message_content: inherit + synchronous_validation: true + inbound_request_url: https://www.example.com/ + inbound_method: POST + fallback_url: null + fallback_method: POST + status_callback: https://www.example.com + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: false + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta /v1/Services/{Sid}: servers: - url: https://messaging.twilio.com @@ -2488,14 +3255,14 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: phone_number: '{service_sid: sid}' short_code: '{service_sid: sid}' alpha_sender: '{service_sid: sid}' - messaging/v1/message: '{messaging_service_sid: sid}' + message: '{messaging_service_sid: sid}' us_app_to_person: '{messaging_service_sid: sid}' us_app_to_person_usecase: '{messaging_service_sid: sid}' + pathType: instance post: description: '' parameters: @@ -2514,12 +3281,42 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My Service! + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + sticky_sender: false + mms_converter: true + smart_encoding: false + fallback_to_long_code: true + scan_message_content: inherit + synchronous_validation: true + area_code_geomatch: true + validity_period: 600 + inbound_request_url: https://www.example.com + inbound_method: POST + fallback_url: null + fallback_method: POST + status_callback: https://www.example.com + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: true + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2623,6 +3420,10 @@ paths: If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. + examples: + update: + value: + StickySender: false get: description: '' parameters: @@ -2641,12 +3442,42 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + friendly_name: My Service! + inbound_request_url: https://www.example.com/ + inbound_method: POST + fallback_url: null + fallback_method: POST + status_callback: https://www.example.com + sticky_sender: true + mms_converter: true + smart_encoding: false + fallback_to_long_code: true + area_code_geomatch: true + validity_period: 600 + scan_message_content: inherit + synchronous_validation: true + usecase: marketing + us_app_to_person_registered: false + use_inbound_webhook_on_number: true + links: + phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes + alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders + messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p + us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta delete: description: '' parameters: @@ -2665,8 +3496,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta /v1/Services/{ServiceSid}/ShortCodes: servers: - url: https://messaging.twilio.com @@ -2677,8 +3506,8 @@ paths: - sid - short_code - country_code - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -2698,12 +3527,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' + examples: + create: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + short_code: '12345' + country_code: US + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateShortCode - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2720,6 +3560,10 @@ paths: Service. required: - ShortCodeSid + examples: + create: + value: + ShortCodeSid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -2765,34 +3609,54 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.short_code' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: short_codes + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + short_codes: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + short_code: '12345' + country_code: US + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListShortCode - x-maturity: - - Beta /v1/Services/{ServiceSid}/ShortCodes/{Sid}: servers: - url: https://messaging.twilio.com @@ -2803,8 +3667,8 @@ paths: - sid - short_code - country_code - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: '' parameters: @@ -2830,8 +3694,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteShortCode - x-maturity: - - Beta get: description: '' parameters: @@ -2857,12 +3719,23 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' + examples: + fetch: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:12:31Z' + date_updated: '2015-07-30T20:12:33Z' + short_code: '12345' + country_code: US + capabilities: + - SMS + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchShortCode - x-maturity: - - Beta /v1/Services/{MessagingServiceSid}/Compliance/Usa2p: servers: - url: https://messaging.twilio.com @@ -2873,9 +3746,9 @@ paths: - brand_registration_sid - campaign_status - date_created - pathType: list parent: /Services/{Sid} mountName: us_app_to_person + pathType: list post: description: '' parameters: @@ -2895,12 +3768,156 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' + examples: + create: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing to + receive text messages from Example Brand. Additionally, end + users can also opt-in by texting START to (111) 222-3333 to + opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + Acme Corporation. You will not receive any more messages from + this number. + help_message: 'Acme Corporation: Please visit www.example.com + to get support. To opt-out, reply STOP.' + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: [] + createWithDefaults: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing to + receive text messages from Example Brand. Additionally, end + users can also opt-in by texting START to (111) 222-3333 to + opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed. You + will not receive any more messages from this number. Reply START + to resubscribe. + help_message: Reply STOP to unsubscribe. Msg&Data Rates May Apply. + opt_in_keywords: + - START + opt_out_keywords: + - STOP + - STOPALL + - UNSUBSCRIBE + - CANCEL + - END + - QUIT + help_keywords: + - HELP + - INFO + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: [] + createWithDefaultsSoleProprietor: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: SOLE_PROPRIETOR + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 0.25 + msg_class: A + tmobile: + brand_tier: LOW + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing to + receive text messages from Example Brand. Additionally, end + users can also opt-in by texting START to (111) 222-3333 to + opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed. You + will not receive any more messages from this number. Reply START + to resubscribe. + help_message: Reply STOP to unsubscribe. Msg&Data Rates May Apply. + opt_in_keywords: + - START + opt_out_keywords: + - STOP + - STOPALL + - UNSUBSCRIBE + - CANCEL + - END + - QUIT + help_keywords: + - HELP + - INFO + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: [] description: Created security: - accountSid_authToken: [] operationId: CreateUsAppToPerson - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -3007,6 +4024,70 @@ paths: - UsAppToPersonUsecase - HasEmbeddedLinks - HasEmbeddedPhone + examples: + create: + value: + BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Description: Send marketing messages about sales to opted in customers. + MessageSamples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + UsAppToPersonUsecase: MARKETING + MessageFlow: End users opt-in by visiting www.example.com and adding + their phone number. They then check a box agreeing to receive + text messages from Example Brand. Additionally, end users can + also opt-in by texting START to (111) 222-3333 to opt in. + OptInMessage: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + OptOutMessage: You have successfully been unsubscribed from Acme + Corporation. You will not receive any more messages from this + number. + HelpMessage: 'Acme Corporation: Please visit www.example.com to + get support. To opt-out, reply STOP.' + OptInKeywords: + - START + OptOutKeywords: + - STOP + HelpKeywords: + - HELP + HasEmbeddedLinks: true + HasEmbeddedPhone: false + createWithDefaults: + value: + BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Description: Send marketing messages about sales to opted in customers. + MessageSamples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + UsAppToPersonUsecase: MARKETING + MessageFlow: End users opt-in by visiting www.example.com and adding + their phone number. They then check a box agreeing to receive + text messages from Example Brand. Additionally, end users can + also opt-in by texting START to (111) 222-3333 to opt in. + OptInMessage: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + OptInKeywords: + - START + HasEmbeddedLinks: true + HasEmbeddedPhone: false + createWithDefaultsSoleProprietor: + value: + BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Description: Send marketing messages about sales to opted in customers. + MessageSamples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + UsAppToPersonUsecase: SOLE_PROPRIETOR + MessageFlow: End users opt-in by visiting www.example.com and adding + their phone number. They then check a box agreeing to receive + text messages from Example Brand. Additionally, end users can + also opt-in by texting START to (111) 222-3333 to opt in. + OptInMessage: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + OptInKeywords: + - START + HasEmbeddedLinks: true + HasEmbeddedPhone: false get: description: '' parameters: @@ -3052,34 +4133,149 @@ paths: items: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + compliance: + - sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in + customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing + to receive text messages from Example Brand. Additionally, + end users can also opt-in by texting START to (111) 222-3333 + to opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For + help, reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + Acme Corporation. You will not receive any more messages from + this number. + help_message: 'Acme Corporation: Please visit www.example.com + to get support. To opt-out, reply STOP.' + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + key: compliance + readFailed: + value: + compliance: + - sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in + customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing + to receive text messages from Example Brand. Additionally, + end users can also opt-in by texting START to (111) 222-3333 + to opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For + help, reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + Acme Corporation. You will not receive any more messages from + this number. + help_message: 'Acme Corporation: Please visit www.example.com + to get support. To opt-out, reply STOP.' + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: + - error_code: 30897 + fields: + - MESSAGE_FLOW + url: https://www.twilio.com/docs/api/errors/30897 + description: The campaign submission has been reviewed and + it was rejected due to Disallowed Content. + meta: + page: 0 + page_size: 50 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + key: compliance description: OK security: - accountSid_authToken: [] operationId: ListUsAppToPerson - x-maturity: - - Beta /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}: servers: - url: https://messaging.twilio.com @@ -3090,9 +4286,9 @@ paths: - brand_registration_sid - campaign_status - date_created - pathType: instance parent: /Services/{Sid} mountName: us_app_to_person + pathType: instance delete: description: '' parameters: @@ -3121,8 +4317,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteUsAppToPerson - x-maturity: - - Beta get: description: '' parameters: @@ -3151,12 +4345,152 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' + examples: + fetch: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing to + receive text messages from Example Brand. Additionally, end + users can also opt-in by texting START to (111) 222-3333 to + opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + Acme Corporation. You will not receive any more messages from + this number. + help_message: 'Acme Corporation: Please visit www.example.com + to get support. To opt-out, reply STOP.' + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: [] + fetchSoleProprietorCampaign: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send confirmation messages about scheduled home repair + services + message_samples: + - Hi! This is John Doe. I'm scheduled to come to your home at + 123 Example Street to repair your roof at 4pm tomorrow. Please + let me know if this time does not work for you anymore + us_app_to_person_usecase: SOLE_PROPRIETOR + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: 'End users call (111)-222-3333 to schedule appointments, + where they''re also asked whether they would like to provide + their phone numbers to receive appointment reminders ' + opt_in_message: 'John Doe''s Home Repair: You are now opted-in. + For help, reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + John Doe's Home Repair. You will not receive any more messages + from this number. + help_message: 'John Doe''s Home Repair: Please call (111)-222-3333 + to get help. To opt-out, please reply STOP' + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: [] + fetchFailedWithErrors: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send confirmation messages about scheduled home repair + services + message_samples: + - Hi! This is John Doe. I'm scheduled to come to your home at + 123 Example Street to repair your roof at 4pm tomorrow. Please + let me know if this time does not work for you anymore + us_app_to_person_usecase: SOLE_PROPRIETOR + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + message_flow: 'End users call (111)-222-3333 to schedule appointments, + where they''re also asked whether they would like to provide + their phone numbers to receive appointment reminders ' + opt_in_message: 'John Doe''s Home Repair: You are now opted-in. + For help, reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + John Doe's Home Repair. You will not receive any more messages + from this number. + help_message: 'John Doe''s Home Repair: Please call (111)-222-3333 + to get help. To opt-out, please reply STOP' + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + mock: false + errors: + - error_code: 30897 + fields: + - MESSAGE_FLOW + url: https://www.twilio.com/docs/api/errors/30897 + description: The campaign submission has been reviewed and it + was rejected due to Disallowed Content. description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPerson - x-maturity: - - Beta /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases: servers: - url: https://messaging.twilio.com @@ -3167,9 +4501,9 @@ paths: x-twilio: defaultOutputProperties: - us_app_to_person_usecases - pathType: list parent: /Services/{Sid} mountName: us_app_to_person_usecases + pathType: list get: description: '' parameters: @@ -3191,18 +4525,240 @@ paths: minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ + examples: + fetchWithBrandRegistrationSid: + value: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person_usecase' + examples: + fetchWithBrandRegistrationSid: + value: + us_app_to_person_usecases: + - code: 2FA + name: Two-Factor authentication (2FA) + description: Two-Factor authentication, one-time use password, + password reset + post_approval_required: false + - code: ACCOUNT_NOTIFICATION + name: Account Notification + description: 'All reminders, alerts, and notifications. (Examples + include: flight delayed, hotel booked, appointment reminders.)' + post_approval_required: false + - code: AGENTS_FRANCHISES + name: Agents and Franchises + description: For brands that have multiple agents, franchises + or offices in the same brand vertical, but require individual + localised numbers per agent/location/office. + post_approval_required: true + - code: CHARITY + name: Charity + description: 'Includes: 5013C Charity + + Does not include: Religious organizations' + post_approval_required: false + - code: PROXY + name: Proxy + description: 'Peer-to-peer app-based group messaging with proxy/pooled + numbers (For example: GroupMe) + + Supporting personalized services and non-exposure of personal + numbers for enterprise or A2P communications. (Examples include: + Uber and AirBnb.)' + post_approval_required: true + - code: CUSTOMER_CARE + name: Customer Care + description: All customer care messaging, including account + management and support + post_approval_required: false + - code: DELIVERY_NOTIFICATION + name: Delivery Notification + description: Information about the status of the delivery of + a product or service + post_approval_required: false + - code: EMERGENCY + name: Emergency + description: Notification services designed to support public + safety / health during natural disasters, armed conflicts, + pandemics and other national or regional emergencies + post_approval_required: true + - code: FRAUD_ALERT + name: Fraud Alert Messaging + description: Fraud alert notification + post_approval_required: false + - code: HIGHER_EDUCATION + name: Higher Education + description: For campaigns created on behalf of Colleges or + Universities and will also include School Districts etc that + fall outside of any "free to the consumer" messaging model + post_approval_required: false + - code: K12_EDUCATION + name: K-12 Education + description: Campaigns created for messaging platforms that + support schools from grades K-12 and distance learning centers. + This is not for Post-Secondary schools. + post_approval_required: true + - code: LOW_VOLUME + name: Low Volume Mixed + description: 'Low throughput, any combination of use-cases. + Examples include: test, demo accounts' + post_approval_required: false + - code: MARKETING + name: Marketing + description: Any communication with marketing and/or promotional + content + post_approval_required: false + - code: MIXED + name: Mixed + description: Mixed messaging reserved for specific consumer + service industry + post_approval_required: false + - code: POLITICAL + name: Political + description: Part of organized effort to influence decision + making of specific group. All campaigns to be verified + post_approval_required: false + - code: POLLING_VOTING + name: Polling and voting + description: Polling and voting + post_approval_required: false + - code: PUBLIC_SERVICE_ANNOUNCEMENT + name: Public Service Announcement + description: An informational message that is meant to raise + the audience awareness about an important issue + post_approval_required: false + - code: SECURITY_ALERT + name: Security Alert + description: A notification that the security of a system, either + software or hardware, has been compromised in some way and + there is an action you need to take + post_approval_required: false + - code: SOCIAL + name: Social + description: 'Communication within or between closed communities + (For example: influencers alerts)' + post_approval_required: true + - code: SWEEPSTAKE + name: Sweepstake + description: Sweepstake + post_approval_required: true + fetchWithoutBrandRegistrationSid: + value: + us_app_to_person_usecases: + - code: 2FA + name: Two-Factor authentication (2FA) + description: Two-Factor authentication, one-time use password, + password reset + post_approval_required: false + - code: ACCOUNT_NOTIFICATION + name: Account Notification + description: 'All reminders, alerts, and notifications. (Examples + include: flight delayed, hotel booked, appointment reminders.)' + post_approval_required: false + - code: AGENTS_FRANCHISES + name: Agents and Franchises + description: For brands that have multiple agents, franchises + or offices in the same brand vertical, but require individual + localised numbers per agent/location/office. + post_approval_required: true + - code: CHARITY + name: Charity + description: 'Includes: 5013C Charity + + Does not include: Religious organizations' + post_approval_required: false + - code: PROXY + name: Proxy + description: 'Peer-to-peer app-based group messaging with proxy/pooled + numbers (For example: GroupMe) + + Supporting personalized services and non-exposure of personal + numbers for enterprise or A2P communications. (Examples include: + Uber and AirBnb.)' + post_approval_required: true + - code: CUSTOMER_CARE + name: Customer Care + description: All customer care messaging, including account + management and support + post_approval_required: false + - code: DELIVERY_NOTIFICATION + name: Delivery Notification + description: Information about the status of the delivery of + a product or service + post_approval_required: false + - code: EMERGENCY + name: Emergency + description: Notification services designed to support public + safety / health during natural disasters, armed conflicts, + pandemics and other national or regional emergencies + post_approval_required: true + - code: FRAUD_ALERT + name: Fraud Alert Messaging + description: Fraud alert notification + post_approval_required: false + - code: HIGHER_EDUCATION + name: Higher Education + description: For campaigns created on behalf of Colleges or + Universities and will also include School Districts etc that + fall outside of any "free to the consumer" messaging model + post_approval_required: false + - code: K12_EDUCATION + name: K-12 Education + description: Campaigns created for messaging platforms that + support schools from grades K-12 and distance learning centers. + This is not for Post-Secondary schools. + post_approval_required: true + - code: LOW_VOLUME + name: Low Volume Mixed + description: 'Low throughput, any combination of use-cases. + Examples include: test, demo accounts' + post_approval_required: false + - code: MARKETING + name: Marketing + description: Any communication with marketing and/or promotional + content + post_approval_required: false + - code: MIXED + name: Mixed + description: Mixed messaging reserved for specific consumer + service industry + post_approval_required: false + - code: POLITICAL + name: Political + description: Part of organized effort to influence decision + making of specific group. All campaigns to be verified + post_approval_required: false + - code: POLLING_VOTING + name: Polling and voting + description: Polling and voting + post_approval_required: false + - code: PUBLIC_SERVICE_ANNOUNCEMENT + name: Public Service Announcement + description: An informational message that is meant to raise + the audience awareness about an important issue + post_approval_required: false + - code: SECURITY_ALERT + name: Security Alert + description: A notification that the security of a system, either + software or hardware, has been compromised in some way and + there is an action you need to take + post_approval_required: false + - code: SOCIAL + name: Social + description: 'Communication within or between closed communities + (For example: influencers alerts)' + post_approval_required: true + - code: SWEEPSTAKE + name: Sweepstake + description: Sweepstake + post_approval_required: true description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPersonUsecase - x-maturity: - - Beta /v1/Services/Usecases: servers: - url: https://messaging.twilio.com @@ -3219,17 +4775,22 @@ paths: application/json: schema: $ref: '#/components/schemas/messaging.v1.usecase' + examples: + fetch: + value: + usecases: + - usecase: notifications + description: Transactional notifications and Alerts for any + Delivery, Account, Reminder, Order, Fraud, Security, Public + Service, or Emergency announcements. + purpose: Notify my users. + - usecase: marketing + description: Marketing messages may contain product information, + offers, and calls to action to engage with your organization. + purpose: Market my services. description: OK security: - accountSid_authToken: [] operationId: FetchUsecase - x-maturity: - - Beta servers: - url: https://messaging.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_microvisor_v1.yaml b/spec/yaml/twilio_microvisor_v1.yaml index d1db7d4d..ffbc752a 100644 --- a/spec/yaml/twilio_microvisor_v1.yaml +++ b/spec/yaml/twilio_microvisor_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: microvisor.v1.account_config: type: object @@ -214,10 +218,6 @@ components: format: uri nullable: true description: The absolute URL of the Secret. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Microvisor description: This is the public Twilio REST API. @@ -229,17 +229,17 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Configs: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: account_configs + pathType: list get: description: Retrieve a list of all Configs for an Account. parameters: @@ -275,34 +275,63 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.account_config' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + configs: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs + readFull: + value: + configs: + - key: first + value: something + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Configs/first + - key: second + value: or other + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Configs/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs description: OK security: - accountSid_authToken: [] operationId: ListAccountConfig - x-maturity: - - Preview post: description: Create a config for an Account. responses: @@ -311,12 +340,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_config' + examples: + createAccountConfig: + value: + key: first + value: place + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Configs/first description: Created security: - accountSid_authToken: [] operationId: CreateAccountConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -333,14 +367,19 @@ paths: required: - Key - Value + examples: + createAccountConfig: + value: + Key: first, + Value: first val /v1/Configs/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: account_configs + pathType: instance get: description: Retrieve a Config for an Account. parameters: @@ -356,12 +395,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_config' + examples: + fetch: + value: + key: first + value: place + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Configs/first description: OK security: - accountSid_authToken: [] operationId: FetchAccountConfig - x-maturity: - - Preview post: description: Update a config for an Account. parameters: @@ -377,12 +421,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_config' + examples: + update: + value: + key: first + value: place + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Configs/first description: OK security: - accountSid_authToken: [] operationId: UpdateAccountConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -395,6 +444,10 @@ paths: description: The config value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a config for an Account. parameters: @@ -410,16 +463,14 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAccountConfig - x-maturity: - - Preview /v1/Secrets: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: account_secrets + pathType: list get: description: Retrieve a list of all Secrets for an Account. parameters: @@ -455,34 +506,61 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.account_secret' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + secrets: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets + readFull: + value: + secrets: + - key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Secrets/first + - key: second + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Secrets/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets description: OK security: - accountSid_authToken: [] operationId: ListAccountSecret - x-maturity: - - Preview post: description: Create a secret for an Account. responses: @@ -491,12 +569,16 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_secret' + examples: + createAccountSecret: + value: + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Secrets/first description: Created security: - accountSid_authToken: [] operationId: CreateAccountSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -513,14 +595,19 @@ paths: required: - Key - Value + examples: + createAccountSecret: + value: + Key: first, + Value: first val /v1/Secrets/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: account_secrets + pathType: instance get: description: Retrieve a Secret for an Account. parameters: @@ -536,12 +623,16 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_secret' + examples: + fetch: + value: + key: first + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Secrets/first description: OK security: - accountSid_authToken: [] operationId: FetchAccountSecret - x-maturity: - - Preview post: description: Update a secret for an Account. parameters: @@ -557,12 +648,16 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.account_secret' + examples: + update: + value: + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Secrets/first description: OK security: - accountSid_authToken: [] operationId: UpdateAccountSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -575,6 +670,10 @@ paths: description: The secret value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a secret for an Account. parameters: @@ -590,19 +689,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAccountSecret - x-maturity: - - Preview /v1/Apps: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: list dependentProperties: app_manifest: '{app_sid: sid}' + pathType: list get: description: Retrieve a list of all Apps for an Account. parameters: @@ -638,45 +735,75 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.app' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + apps: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + next_page_url: null + key: apps + readFull: + value: + apps: + - sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + hash: hash + unique_name: unique name + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + app_manifests: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0 + next_page_url: null + key: apps description: OK security: - accountSid_authToken: [] operationId: ListApp - x-maturity: - - Preview /v1/Apps/{Sid}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: instance dependentProperties: app_manifest: '{app_sid: sid}' + pathType: instance get: description: Fetch a specific App. parameters: @@ -692,12 +819,22 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.app' + examples: + fetch: + value: + sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + hash: hash + unique_name: look at this crazy app + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + app_manifests: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest description: OK security: - accountSid_authToken: [] operationId: FetchApp - x-maturity: - - Preview delete: description: Delete a specific App. parameters: @@ -713,17 +850,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteApp - x-maturity: - - Preview /v1/Apps/{AppSid}/Manifest: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Apps/{Sid} mountName: app_manifests + pathType: instance get: description: Retrieve the Manifest for an App. parameters: @@ -739,24 +874,29 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.app.app_manifest' + examples: + fetch: + value: + app_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + hash: some hash + encoded_bytes: some value + url: https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest description: OK security: - accountSid_authToken: [] operationId: FetchAppManifest - x-maturity: - - Preview /v1/Devices: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: list dependentProperties: device_config: '{device_sid: sid}' device_secret: '{device_sid: sid}' + pathType: list get: description: Retrieve a list of all Devices registered with the Account. parameters: @@ -792,46 +932,87 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.device' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + devices: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + next_page_url: null + key: devices + readFull: + value: + devices: + - sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: This is my device; there are many like it. + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: up-to-date + update_error_code: 0 + reported_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: true + date_expires: '2021-01-01T12:34:56Z' + date_created: '2021-01-01T12:34:56Z' + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0 + next_page_url: null + key: devices description: OK security: - accountSid_authToken: [] operationId: ListDevice - x-maturity: - - Preview /v1/Devices/{Sid}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - pathType: instance dependentProperties: device_config: '{device_sid: sid}' device_secret: '{device_sid: sid}' + pathType: instance get: description: Fetch a specific Device. parameters: @@ -847,12 +1028,33 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device' + examples: + fetch: + value: + sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: This is my device; there are many like it. + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: up-to-date + update_error_code: 0 + reported_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: true + date_expires: '2021-01-01T12:34:56Z' + date_created: '2021-01-01T12:34:56Z' + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets description: OK security: - accountSid_authToken: [] operationId: FetchDevice - x-maturity: - - Preview post: description: Update a specific Device. parameters: @@ -868,12 +1070,55 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device' + examples: + update: + value: + sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: UniqueName + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: pending + update_error_code: 0 + reported_sid: null + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: false + date_expires: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets + restartApp: + value: + sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: UniqueName + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + app: + target_sid: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_hash: null + date_targeted: '2021-01-01T12:34:56Z' + update_status: pending + update_error_code: 0 + reported_sid: null + date_reported: '2021-01-01T12:34:56Z' + logging: + enabled: false + date_expires: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + device_configs: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs + device_secrets: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets description: OK security: - accountSid_authToken: [] operationId: UpdateDevice - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -894,15 +1139,27 @@ paths: type: boolean description: A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours. + RestartApp: + type: boolean + description: Set to true to restart the App running on the Device. + examples: + update: + value: + UniqueName: unique_name + TargetApp: KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + LoggingEnabled: false + restartApp: + value: + RestartApp: true /v1/Devices/{DeviceSid}/Configs: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Devices/{Sid} mountName: device_configs + pathType: list get: description: Retrieve a list of all Configs for a Device. parameters: @@ -944,34 +1201,65 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.device.device_config' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + configs: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs + readFull: + value: + configs: + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: some value + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: second + value: some value + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0 + next_page_url: null + key: configs description: OK security: - accountSid_authToken: [] operationId: ListDeviceConfig - x-maturity: - - Preview post: description: Create a config for a Microvisor Device. parameters: @@ -987,12 +1275,18 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_config' + examples: + createAccountConfig: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: some value + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first description: Created security: - accountSid_authToken: [] operationId: CreateDeviceConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1009,15 +1303,20 @@ paths: required: - Key - Value + examples: + createAccountConfig: + value: + Key: first, + Value: first val /v1/Devices/{DeviceSid}/Configs/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Devices/{Sid} mountName: device_configs + pathType: instance get: description: Retrieve a Config for a Device. parameters: @@ -1039,12 +1338,18 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_config' + examples: + fetch: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: some value + date_updated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first description: OK security: - accountSid_authToken: [] operationId: FetchDeviceConfig - x-maturity: - - Preview post: description: Update a config for a Microvisor Device. parameters: @@ -1066,12 +1371,18 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_config' + examples: + update: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + value: place + date_updated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first description: OK security: - accountSid_authToken: [] operationId: UpdateDeviceConfig - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1084,6 +1395,10 @@ paths: description: The config value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a config for a Microvisor Device. parameters: @@ -1105,17 +1420,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeviceConfig - x-maturity: - - Preview /v1/Devices/{DeviceSid}/Secrets: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Devices/{Sid} mountName: device_secrets + pathType: list get: description: Retrieve a list of all Secrets for a Device. parameters: @@ -1157,34 +1470,63 @@ paths: items: $ref: '#/components/schemas/microvisor.v1.device.device_secret' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + secrets: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets + readFull: + value: + secrets: + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first + - device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: second + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/second + meta: + page: 0 + page_size: 50 + first_page_url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + previous_page_url: null + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0 + next_page_url: null + key: secrets description: OK security: - accountSid_authToken: [] operationId: ListDeviceSecret - x-maturity: - - Preview post: description: Create a secret for a Microvisor Device. parameters: @@ -1200,12 +1542,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_secret' + examples: + createAccountSecret: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first description: Created security: - accountSid_authToken: [] operationId: CreateDeviceSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1222,15 +1569,20 @@ paths: required: - Key - Value + examples: + createAccountSecret: + value: + Key: first, + Value: first val /v1/Devices/{DeviceSid}/Secrets/{Key}: servers: - url: https://microvisor.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Devices/{Sid} mountName: device_secrets + pathType: instance get: description: Retrieve a Secret for a Device. parameters: @@ -1252,12 +1604,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_secret' + examples: + fetch: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:57Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first description: OK security: - accountSid_authToken: [] operationId: FetchDeviceSecret - x-maturity: - - Preview post: description: Update a secret for a Microvisor Device. parameters: @@ -1279,12 +1636,17 @@ paths: application/json: schema: $ref: '#/components/schemas/microvisor.v1.device.device_secret' + examples: + update: + value: + device_sid: UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + key: first + date_rotated: '2021-01-01T12:34:56Z' + url: https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first description: OK security: - accountSid_authToken: [] operationId: UpdateDeviceSecret - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1297,6 +1659,10 @@ paths: description: The secret value; up to 4096 characters. required: - Value + examples: + update: + value: + Value: place delete: description: Delete a secret for a Microvisor Device. parameters: @@ -1318,12 +1684,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeviceSecret - x-maturity: - - Preview servers: - url: https://microvisor.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index ba183343..c6ad7f4a 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: monitor.v1.alert: type: object @@ -325,10 +329,6 @@ components: format: uri-map nullable: true description: The absolute URLs of related resources. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Monitor description: This is the public Twilio REST API. @@ -340,7 +340,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Alerts/{Sid}: @@ -372,12 +372,32 @@ paths: application/json: schema: $ref: '#/components/schemas/monitor.v1.alert-instance' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + alert_text: alert_text + api_version: '2010-04-01' + date_created: '2015-07-30T20:00:00Z' + date_generated: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + error_code: error_code + log_level: log_level + more_info: more_info + request_method: GET + request_url: http://www.example.com + request_variables: request_variables + resource_sid: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + response_body: response_body + response_headers: response_headers + request_headers: request_headers + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: PNe2cd757cd5257b0217a447933a0290d2 description: OK security: - accountSid_authToken: [] operationId: FetchAlert - x-maturity: - - GA /v1/Alerts: servers: - url: https://monitor.twilio.com @@ -398,6 +418,11 @@ paths: `notice`, or `debug`.' schema: type: string + examples: + readEmpty: + value: log_level + readFull: + value: log_level - name: StartDate in: query description: Only include alerts that occurred on or after this date and time. @@ -406,6 +431,11 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2016-01-01' + readFull: + value: '2016-01-01' - name: EndDate in: query description: Only include alerts that occurred on or before this date and @@ -414,6 +444,11 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2016-01-01' + readFull: + value: '2016-01-01' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -446,34 +481,70 @@ paths: items: $ref: '#/components/schemas/monitor.v1.alert' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + alerts: [] + meta: + first_page_url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 + key: alerts + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 + readFull: + value: + alerts: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + alert_text: alert_text + api_version: '2010-04-01' + date_created: '2015-07-30T20:00:00Z' + date_generated: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + error_code: error_code + log_level: log_level + more_info: more_info + request_method: GET + request_url: http://www.example.com + resource_sid: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://monitor.twilio.com/v1/Alerts/NOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: PNe2cd757cd5257b0217a447933a0290d2 + meta: + first_page_url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 + key: alerts + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Alerts?LogLevel=log_level&StartDate=2016-01-01&EndDate=2016-01-01&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAlert - x-maturity: - - GA /v1/Events/{Sid}: servers: - url: https://monitor.twilio.com @@ -503,12 +574,32 @@ paths: application/json: schema: $ref: '#/components/schemas/monitor.v1.event' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: account + description: null + event_data: + friendly_name: + previous: SubAccount Created at 2014-10-03 09:48 am + updated: Mr. Friendly + event_date: '2014-10-03T16:48:25Z' + event_type: account.updated + links: + actor: https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: account + sid: AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: api + source_ip_address: 10.86.6.250 + url: https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEvent - x-maturity: - - GA /v1/Events: servers: - url: https://monitor.twilio.com @@ -532,11 +623,21 @@ paths: minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ + examples: + readFull: + value: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: EventType in: query description: Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types). schema: type: string + examples: + readFull: + value: event_type + readEmpty: + value: event_type - name: ResourceSid in: query description: Only include events that refer to this resource. Useful for discovering @@ -546,6 +647,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readFull: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: SourceIpAddress in: query description: Only include events that originated from this IP address. Useful @@ -553,6 +659,11 @@ paths: Console. schema: type: string + examples: + readFull: + value: source_ip_address + readEmpty: + value: source_ip_address - name: StartDate in: query description: Only include events that occurred on or after this date. Specify @@ -560,6 +671,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: EndDate in: query description: Only include events that occurred on or before this date. Specify @@ -567,6 +683,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02' + readEmpty: + value: '2008-01-02' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -599,36 +720,73 @@ paths: items: $ref: '#/components/schemas/monitor.v1.event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + events: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: account + description: null + event_data: + friendly_name: + previous: SubAccount Created at 2014-10-03 09:48 am + updated: Mr. Friendly + event_date: '2014-10-03T16:48:25Z' + event_type: account.updated + links: + actor: https://api.twilio.com/2010-04-01/Accounts/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: account + sid: AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: api + source_ip_address: 10.86.6.250 + url: https://monitor.twilio.com/v1/Events/AEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 + readEmpty: + value: + events: [] + meta: + first_page_url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://monitor.twilio.com/v1/Events?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEvent - x-maturity: - - GA servers: - url: https://monitor.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 2a609fa8..f3d91614 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: notify.v1.service.binding: type: object @@ -447,10 +451,15 @@ components: nullable: true description: Callback configuration that enables delivery callbacks, default false - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + user_binding_enum_binding_type: + type: string + enum: + - apn + - gcm + - sms + - fcm + - facebook-messenger + - alexa info: title: Twilio - Notify description: This is the public Twilio REST API. @@ -462,13 +471,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -476,8 +485,8 @@ paths: - endpoint - binding_type - address - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -507,12 +516,29 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service.binding' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73 + binding_type: apn + credential_sid: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + endpoint: '26607274' + identity: '24987039' + notification_protocol_version: '3' + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tags: + - '26607274' + links: + user: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039 + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchBinding - x-maturity: - - Beta delete: description: '' parameters: @@ -542,12 +568,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBinding - x-maturity: - - Beta /v1/Services/{ServiceSid}/Bindings: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -555,8 +579,8 @@ paths: - endpoint - binding_type - address - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -576,12 +600,29 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service.binding' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73 + binding_type: apn + credential_sid: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + endpoint: '26607274' + identity: '24987039' + notification_protocol_version: '3' + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tags: + - '26607274' + links: + user: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039 + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateBinding - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -638,6 +679,17 @@ paths: - Identity - BindingType - Address + examples: + create: + value: + Address: address + BindingType: apn + CredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Endpoint: endpoint + Identity: '24987039' + NotificationProtocolVersion: notification_protocol_version + Tag: + - tag get: description: '' parameters: @@ -673,6 +725,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - identity + readFull: + value: + - identity - name: Tag in: query description: 'Only list Bindings that have all of the specified Tags. The @@ -682,6 +741,13 @@ paths: type: array items: type: string + examples: + readEmpty: + value: + - tag + readFull: + value: + - tag - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -714,38 +780,75 @@ paths: items: $ref: '#/components/schemas/notify.v1.service.binding' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + bindings: [] + meta: + first_page_url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 + key: bindings + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 + readFull: + value: + bindings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73 + binding_type: apn + credential_sid: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + endpoint: '26607274' + identity: '24987039' + notification_protocol_version: '3' + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tags: + - '26607274' + links: + user: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039 + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 + key: bindings + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListBinding - x-maturity: - - Beta /v1/Credentials: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -787,34 +890,63 @@ paths: items: $ref: '#/components/schemas/notify.v1.credential' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credentials: + - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials + readEmpty: + value: + credentials: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0 + next_page_url: null + key: credentials description: OK security: - accountSid_authToken: [] operationId: ListCredential - x-maturity: - - Beta post: description: '' responses: @@ -823,12 +955,21 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.credential' + examples: + create: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredential - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -870,10 +1011,14 @@ paths: console under Settings / Cloud messaging.' required: - Type + examples: + create: + value: + Type: apn /v1/Credentials/{Sid}: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -899,12 +1044,21 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.credential' + examples: + fetch: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredential - x-maturity: - - Beta post: description: '' parameters: @@ -924,12 +1078,21 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.credential' + examples: + update: + value: + sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test slow create + type: apn + sandbox: 'False' + date_created: '2015-10-07T17:50:01Z' + date_updated: '2015-10-07T17:50:01Z' + url: https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCredential - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -965,6 +1128,10 @@ paths: type: string description: '[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.' + examples: + update: + value: + FriendlyName: Test slow create delete: description: '' parameters: @@ -984,19 +1151,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredential - x-maturity: - - Beta /v1/Services/{ServiceSid}/Notifications: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - priority - title - pathType: list parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -1016,12 +1181,56 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service.notification' + examples: + create: + value: + sid: NTb8021351170b4e1286adaac3fdd6d082 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: IS699b53e02da45a1ba9d13b7d7d2766af + date_created: '2016-03-24T23:42:28Z' + identities: + - jing + tags: [] + segments: [] + priority: high + ttl: 2419200 + title: test + body: body + sound: null + action: null + data: null + apn: null + fcm: null + gcm: null + sms: null + facebook_messenger: null + alexa: null + createDirectNotification: + value: + sid: NTb8021351170b4e1286adaac3fdd6d082 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: IS699b53e02da45a1ba9d13b7d7d2766af + date_created: '2016-03-24T23:42:28Z' + identities: [] + tags: [] + segments: [] + priority: high + ttl: 2419200 + title: null + body: body + sound: null + action: null + data: null + apn: null + fcm: null + gcm: null + sms: null + facebook_messenger: null + alexa: null description: Created security: - accountSid_authToken: [] operationId: CreateNotification - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1162,6 +1371,18 @@ paths: a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel. + examples: + create: + value: + Identity: jing + Body: body + Priority: high + Title: test + DeliveryCallbackUrl: hello + createDirectNotification: + value: + ToBinding: '{"binding_type":"apn", "address":"0efb85d06b3cc1bf290545fde4775a929d46b3541aaa4aa167e420b6c8b0ff15"}' + Body: body x-twilio: conditional: - - identity @@ -1169,18 +1390,18 @@ paths: /v1/Services: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: binding: '{service_sid: sid}' notification: '{service_sid: sid}' - notify/v1/user: '{service_sid: sid}' - notify/v1/segment: '{service_sid: sid}' + user: '{service_sid: sid}' + segment: '{service_sid: sid}' + pathType: list post: description: '' responses: @@ -1189,12 +1410,38 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service' + examples: + create: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + messaging_service_sid: null + facebook_messenger_page_id: '4' + alexa_skill_id: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1273,6 +1520,21 @@ paths: type: boolean description: Callback configuration that enables delivery callbacks, default false + examples: + create: + value: + FriendlyName: friendly_name + ApnCredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + GcmCredentialSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FacebookMessengerPageId: '4' + DefaultApnNotificationProtocolVersion: '3' + DefaultGcmNotificationProtocolVersion: '3' + DefaultFcmNotificationProtocolVersion: '3' + LogEnabled: 'True' + Type: S + DeliveryCallbackUrl: Hello + DeliveryCallbackEnabled: 'True' get: description: '' parameters: @@ -1313,49 +1575,95 @@ paths: items: $ref: '#/components/schemas/notify.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + next_page_url: null + key: services + services: + - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + messaging_service_sid: null + facebook_messenger_page_id: '4' + alexa_skill_id: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + previous_page_url: null + url: https://notify.twilio.com/v1/Services?PageSize=50&Page=0 + next_page_url: null + key: services + services: [] description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta /v1/Services/{Sid}: servers: - url: https://notify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: binding: '{service_sid: sid}' notification: '{service_sid: sid}' - notify/v1/user: '{service_sid: sid}' - notify/v1/segment: '{service_sid: sid}' + user: '{service_sid: sid}' + segment: '{service_sid: sid}' + pathType: instance delete: description: '' parameters: @@ -1375,8 +1683,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta get: description: '' parameters: @@ -1396,12 +1702,38 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service' + examples: + fetch: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + messaging_service_sid: null + facebook_messenger_page_id: '4' + alexa_skill_id: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta post: description: '' parameters: @@ -1421,12 +1753,38 @@ paths: application/json: schema: $ref: '#/components/schemas/notify.v1.service' + examples: + update: + value: + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 733c7f0f-6541-42ec-84ce-e2ae1cac588c + date_created: '2016-03-09T20:22:31Z' + date_updated: '2016-03-09T20:22:31Z' + apn_credential_sid: null + gcm_credential_sid: null + fcm_credential_sid: null + default_apn_notification_protocol_version: '3' + default_gcm_notification_protocol_version: '3' + default_fcm_notification_protocol_version: '3' + default_alexa_notification_protocol_version: '3' + messaging_service_sid: null + alexa_skill_id: null + facebook_messenger_page_id: '4' + log_enabled: true + type: S + delivery_callback_url: Hello + delivery_callback_enabled: true + url: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + bindings: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings + notifications: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + segments: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments + users: https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1505,9 +1863,20 @@ paths: type: boolean description: Callback configuration that enables delivery callbacks, default false + examples: + update: + value: + FriendlyName: friendly_name + ApnCredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + GcmCredentialSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FacebookMessengerPageId: '4' + DefaultApnNotificationProtocolVersion: '3' + DefaultGcmNotificationProtocolVersion: '3' + DefaultFcmNotificationProtocolVersion: '3' + LogEnabled: 'True' + Type: S + DeliveryCallbackUrl: Hello + DeliveryCallbackEnabled: 'True' servers: - url: https://notify.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_numbers_v1.yaml b/spec/yaml/twilio_numbers_v1.yaml index 893997ca..80c54436 100644 --- a/spec/yaml/twilio_numbers_v1.yaml +++ b/spec/yaml/twilio_numbers_v1.yaml @@ -1,5 +1,17 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + authorization_document_enum_status: + type: string + enum: + - opened + - signing + - signed + - canceled + - failed numbers.v1.bulk_eligibility: type: object properties: @@ -66,6 +78,24 @@ components: - invalid-hosting-account-sid - eligible - eligible-by-manual-process + dependent_order_enum_status: + type: string + enum: + - twilio-processing + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + dependent_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill numbers.v1.eligibility: type: object properties: @@ -100,10 +130,136 @@ components: - invalid-phone-number - invalid-hosting-account-sid - eligible - securitySchemes: - accountSid_authToken: - type: http - scheme: basic + hosted_number_order_enum_status: + type: string + enum: + - twilio-processing + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + hosted_number_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill + numbers.v1.porting_bulk_portability: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KZ[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this Portability + check. + status: + type: string + $ref: '#/components/schemas/porting_bulk_portability_enum_status' + nullable: true + description: The Status of this Portability check. One of `in-progress`, + `completed` or `expired`. + datetime_created: + type: string + format: date-time + nullable: true + description: The date that the Portability check was created, given in ISO + 8601 format. + phone_numbers: + type: array + items: {} + nullable: true + description: 'Contains a list with all the information of the requested + phone numbers. Each phone number contains the following properties: `phone_number`: + The phone number which portability is to be checked. `portable`: Boolean + flag specifying if phone number is portable or not. `not_portable_reason`: + Reason why the phone number cannot be ported into Twilio, `null` otherwise. + `not_portable_reason_code`: The Portability Reason Code for the phone + number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: + Boolean flag specifying if PIN and account number is required for the + phone number. `number_type`: The type of the requested phone number. `country` + Country the phone number belongs to. `messaging_carrier` Current messaging + carrier of the phone number. `voice_carrier` Current voice carrier of + the phone number.' + url: + type: string + format: uri + nullable: true + description: This is the url of the request that you're trying to reach + out to locate the resource. + porting_bulk_portability_enum_status: + type: string + enum: + - in-progress + - completed + - expired + numbers.v1.porting_portability: + type: object + properties: + phone_number: + type: string + format: phone-number + nullable: true + description: The phone number which portability is to be checked. Phone + numbers are in E.164 format (e.g. +16175551212). + portable: + type: boolean + nullable: true + description: Boolean flag specifying if phone number is portable or not. + pin_and_account_number_required: + type: boolean + nullable: true + description: Boolean flag specifying if PIN and account number is required + for the phone number. + not_portable_reason: + type: string + nullable: true + description: Reason why the phone number cannot be ported into Twilio, `null` + otherwise. + not_portable_reason_code: + type: integer + nullable: true + description: The Portability Reason Code for the phone number if it cannot + be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, + `22133`, `22102` or `22135`. + number_type: + type: string + $ref: '#/components/schemas/porting_portability_enum_number_type' + nullable: true + description: The type of the requested phone number. One of `LOCAL`, `UNKNOWN`, + `MOBILE`, `TOLL-FREE`. + country: + type: string + format: iso-country-code + nullable: true + description: Country the phone number belongs to. + messaging_carrier: + type: string + nullable: true + description: Current messaging carrier of the phone number + voice_carrier: + type: string + nullable: true + description: Current voice carrier of the phone number + url: + type: string + format: uri + nullable: true + description: This is the url of the request that you're trying to reach + out to locate the resource. + porting_portability_enum_number_type: + type: string + enum: + - LOCAL + - UNKNOWN + - MOBILE + - TOLL-FREE info: title: Twilio - Numbers description: This is the public Twilio REST API. @@ -115,25 +271,48 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/HostedNumber/Eligibility/Bulk: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: bulk_eligibilities + pathType: list + post: + description: Create a bulk eligibility check for a set of numbers that you want + to host in Twilio. + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.bulk_eligibility' + examples: + create: + value: + friendly_name: Test + status: QUEUED + date_created: '2023-05-03T03:12:30Z' + date_completed: null + request_id: ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: [] + url: https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Accepted + security: + - accountSid_authToken: [] + operationId: CreateBulkEligibility /v1/HostedNumber/Eligibility/Bulk/{RequestId}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: bulk_eligibilities + pathType: instance get: description: Fetch an eligibility bulk check that you requested to host in Twilio. parameters: @@ -152,23 +331,243 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v1.bulk_eligibility' + examples: + fetch: + value: + friendly_name: Foo + status: SUCCESSFUL + date_created: '2023-04-24T14:47:04Z' + date_completed: '2023-04-24T14:47:06Z' + results: + - phone_number: '+18778894546' + account_sid: AC93b447ff5bd2abac37f1cbab2a871430 + eligibility_status: INELIGIBLE + eligibility_sub_status: ALREADY_IN_TWILIO + ineligibility_reason: ALREADY_IN_TWILIO_BUT_NOT_IN_USE + next_step: CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS + voice_provider: null + messaging_provider: null + phone_number_type: TOLL_FREE + hosting_order_sid: null + hosting_order_status: null + iso_country_code: US + inventory_status: in-testing + inventory_account_sid: AC93b447ff5bd2abac37f1cbab2a871430 + url: https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + request_id: ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchBulkEligibility - x-maturity: - - Beta /v1/HostedNumber/Eligibility: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list mountName: eligibilities + pathType: list + post: + description: Create an eligibility check for a number that you want to host + in Twilio. + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.eligibility' + examples: + create: + value: + results: + - phone_number: '+18778894546' + account_sid: AC93b447ff5bd2abac37f1cbab2a871430 + eligibility_status: INELIGIBLE + eligibility_sub_status: ALREADY_IN_TWILIO + ineligibility_reason: ALREADY_IN_TWILIO_BUT_NOT_IN_USE + next_step: CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS + voice_provider: null + messaging_provider: null + phone_number_type: TOLL_FREE + hosting_order_sid: null + hosting_order_status: null + iso_country_code: US + inventory_status: in-testing + inventory_account_sid: AC93b447ff5aa2abac37e3cbab2a871430 + - phone_number: '4565433456' + account_sid: null + eligibility_status: INELIGIBLE + eligibility_sub_status: NUMBER_FORMAT_INELIGIBLE + ineligibility_reason: NUMBER_FORMAT_INELIGIBLE + next_step: EDIT_INELIGIBLE_NUMBER + voice_provider: null + messaging_provider: null + phone_number_type: null + hosting_order_sid: null + hosting_order_status: null + iso_country_code: null + inventory_status: null + inventory_account_sid: null + description: Created + security: + - accountSid_authToken: [] + operationId: CreateEligibility + /v1/Porting/Portability/{Sid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - status + mountName: porting_bulk_portabilities + pathType: instance + get: + description: Fetch a previous portability check. This should return the current + status of the validation and the result for all the numbers provided, given + that they have been validated (as this process is performed asynchronously). + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies the Portability + check. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KZ[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_bulk_portability' + examples: + fetch: + value: + sid: KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + datetime_created: '2015-07-30T20:00:00Z' + phone_numbers: + - phone_number: '+14153334440' + portable: true + pin_and_account_number_required: true + not_portable_reason: null + not_portable_reason_code: null + number_type: LOCAL + country: US + messaging_carrier: string + voice_carrier: string + - phone_number: '+18002178781' + portable: false + pin_and_account_number_required: false + not_portable_reason: MANUAL_PORTING_AVAILABLE + not_portable_reason_code: 22133 + number_type: TOLL-FREE + country: US + messaging_carrier: Verizon + voice_carrier: Verizon + url: https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPortingBulkPortability + /v1/Porting/Portability: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - status + mountName: porting_bulk_portabilities + pathType: list + post: + description: Allows to check if a list of phone numbers can be ported to Twilio + or not. This is done asynchronous for each phone number. + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_bulk_portability' + examples: + create: + value: + sid: KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + datetime_created: '2015-07-30T20:00:00Z' + phone_numbers: [] + url: https://numbers.twilio.com/v1/Porting/Portability/KZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Accepted + security: + - accountSid_authToken: [] + operationId: CreatePortingBulkPortability + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePortingBulkPortabilityRequest + properties: + PhoneNumbers: + type: array + items: + type: string + description: The phone numbers which portability is to be checked. + This should be a list of strings. Phone numbers are in E.164 format + (e.g. +16175551212). . + required: + - PhoneNumbers + examples: + create: + value: + PhoneNumbers: + - '+14153334440' + - '+18002178781' + /v1/Porting/Portability/PhoneNumber/{PhoneNumber}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: porting_portabilities + pathType: instance + get: + description: Allows to check if a single phone number can be ported to Twilio + or not. + parameters: + - name: PhoneNumber + in: path + description: The phone number which portability is to be checked. Phone numbers + are in E.164 format (e.g. +16175551212). + schema: + type: string + format: phone-number + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_portability' + examples: + fetch: + value: + phone_number: '+18001234567' + portable: false + pin_and_account_number_required: false + not_portable_reason: MANUAL_PORTING_AVAILABLE + not_portable_reason_code: 22133 + number_type: TOLL-FREE + country: US + messaging_carrier: Verizon + voice_carrier: Verizon + url: https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/+18001234567 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPortingPortability servers: - url: https://numbers.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index 3a7f30b8..80eaf590 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -1,5 +1,74 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: + numbers.v2.authorization_document: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this AuthorizationDocument. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that is associated with this AuthorizationDocument. + status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + nullable: true + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + email: + type: string + nullable: true + description: Email that this AuthorizationDocument will be sent to for signing. + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + url: + type: string + format: uri + nullable: true + links: + type: object + format: uri-map + nullable: true + authorization_document_enum_status: + type: string + enum: + - opened + - signing + - signed + - canceled + - failed numbers.v2.regulatory_compliance.bundle: type: object properties: @@ -174,6 +243,142 @@ components: enum: - individual - business + numbers.v2.authorization_document.dependent_hosted_number_order: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this Authorization + Document + bulk_hosting_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BHR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the bulk hosting + request associated with this HostedNumberOrder. + next_step: + type: string + nullable: true + description: The next step you need to take to complete the hosted number + order and request it successfully. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique SID identifier of the Account. + incoming_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + phone_number: + type: string + format: phone-number + nullable: true + description: An E164 formatted phone number hosted by this HostedNumberOrder. + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean + nullable: true + description: A mapping of capabilities this hosted phone number will have + enabled on Twilio's platform. + friendly_name: + type: string + nullable: true + description: A human readable description of this resource, up to 64 characters. + status: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + nullable: true + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + failure_reason: + type: string + nullable: true + description: A message that explains why a hosted_number_order went to status + "action-required" + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + email: + type: string + nullable: true + description: Email of the owner of this phone number that is being hosted. + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + contact_title: + type: string + nullable: true + description: The title of the person authorized to sign the Authorization + Document for this phone number. + contact_phone_number: + type: string + format: phone-number + nullable: true + description: The contact phone number of the person authorized to sign the + Authorization Document. + dependent_hosted_number_order_enum_status: + type: string + enum: + - received + - verified + - pending-loa + - carrier-processing + - completed + - failed + - action-required numbers.v2.regulatory_compliance.end_user: type: object properties: @@ -319,6 +524,150 @@ components: enum: - compliant - noncompliant + numbers.v2.hosted_number_order: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this HostedNumberOrder. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the account. + incoming_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) + resource that represents the phone number being hosted. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the [Authorization + Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) + the user needs to sign. + phone_number: + type: string + format: phone-number + nullable: true + description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) + format, e.g., +16175551212 + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean + nullable: true + description: Set of booleans describing the capabilities hosted on Twilio's + platform. SMS is currently only supported. + friendly_name: + type: string + nullable: true + description: A 64 character string that is a human-readable text that describes + this resource. + status: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + nullable: true + description: 'Status of this resource. It can hold one of the values: 1. + Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, + 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders + Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) + section for more information on each of these statuses.' + failure_reason: + type: string + nullable: true + description: A message that explains why a hosted_number_order went to status + "action-required" + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + email: + type: string + nullable: true + description: Email of the owner of this phone number that is being hosted. + cc_emails: + type: array + items: + type: string + nullable: true + description: A list of emails that LOA document for this HostedNumberOrder + will be carbon copied to. + url: + type: string + format: uri + nullable: true + description: The URL of this HostedNumberOrder. + contact_title: + type: string + nullable: true + description: The title of the person authorized to sign the Authorization + Document for this phone number. + contact_phone_number: + type: string + format: phone-number + nullable: true + description: The contact phone number of the person authorized to sign the + Authorization Document. + bulk_hosting_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BHR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the bulk hosting + request associated with this HostedNumberOrder. + next_step: + type: string + nullable: true + description: The next step you need to take to complete the hosted number + order and request it successfully. + hosted_number_order_enum_status: + type: string + enum: + - received + - verified + - pending-loa + - carrier-processing + - completed + - failed + - action-required numbers.v2.regulatory_compliance.bundle.item_assignment: type: object properties: @@ -594,10 +943,6 @@ components: format: uri nullable: true description: The absolute URL of the Supporting Document Type resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Numbers description: This is the public Twilio REST API. @@ -609,25 +954,301 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: + /v2/HostedNumber/AuthorizationDocuments/{Sid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_order: '{signing_document_sid: sid}' + pathType: instance + get: + description: Fetch a specific AuthorizationDocument. + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.authorization_document' + examples: + fetch: + value: + address_sid: AD11111111111111111111111111111111 + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + links: + dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchAuthorizationDocument + delete: + description: Cancel the AuthorizationDocument request. + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteAuthorizationDocument + /v2/HostedNumber/AuthorizationDocuments: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_order: '{signing_document_sid: sid}' + pathType: list + get: + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. + parameters: + - name: Email + in: query + description: Email that this AuthorizationDocument will be sent to for signing. + schema: + type: string + examples: + readEmpty: + value: test+hosted@twilio.com + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + examples: + readEmpty: + value: signed + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListAuthorizationDocumentResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/numbers.v2.authorization_document' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0 + items: + - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: ListAuthorizationDocument + post: + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.authorization_document' + examples: + create: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateAuthorizationDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateAuthorizationDocumentRequest + properties: + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + ContactPhoneNumber: + type: string + format: phone-number + description: The contact phone number of the person authorized to + sign the Authorization Document. + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + required: + - AddressSid + - Email + - ContactPhoneNumber + - HostedNumberOrderSids + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' /v2/RegulatoryCompliance/Bundles: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - regulation_sid - friendly_name - pathType: list dependentProperties: evaluation: '{bundle_sid: sid}' item_assignment: '{bundle_sid: sid}' bundle_copy: '{bundle_sid: sid}' replace_items: '{bundle_sid: sid}' parent: /RegulatoryCompliance + pathType: list post: description: Create a new Bundle. responses: @@ -636,12 +1257,28 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies description: Created security: - accountSid_authToken: [] operationId: CreateBundle - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -684,6 +1321,13 @@ paths: required: - FriendlyName - Email + examples: + create: + value: + FriendlyName: friendly_name + Email: email + RegulationSid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + StatusCallback: http://www.example.com get: description: Retrieve a list of all Bundles for an account. parameters: @@ -695,12 +1339,24 @@ paths: schema: type: string $ref: '#/components/schemas/bundle_enum_status' + examples: + readFull: + value: draft + readApprovedAuMobileWithDate: + value: twilio-approved + readApprovedAuMobileDateLess: + value: twilio-approved + readApprovedJapanTollfreeDateBetween: + value: twilio-approved - name: FriendlyName in: query description: The string that you assigned to describe the resource. The column can contain 255 variable characters. schema: type: string + examples: + readFull: + value: friendly_name - name: RegulationSid in: query description: The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) @@ -710,24 +1366,48 @@ paths: minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ + examples: + readFull: + value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: IsoCountry in: query description: The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request. schema: type: string + examples: + readFull: + value: US + readApprovedAuMobileWithDate: + value: AU + readApprovedAuMobileDateLess: + value: AU + readApprovedJapanTollfreeDateBetween: + value: JP - name: NumberType in: query description: The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`. schema: type: string + examples: + readFull: + value: mobile + readApprovedAuMobileWithDate: + value: mobile + readApprovedAuMobileDateLess: + value: mobile + readApprovedJapanTollfreeDateBetween: + value: tollfree - name: HasValidUntilDate in: query description: Indicates that the Bundle is a valid Bundle until a specified expiration date. schema: type: boolean + examples: + readApprovedAuMobileWithDate: + value: 'true' - name: SortBy in: query description: Can be `valid-until` or `date-updated`. Defaults to `date-created`. @@ -758,6 +1438,11 @@ paths: schema: type: string format: date-time + examples: + readApprovedAuMobileDateLess: + value: '2022-11-29T23:59:59Z' + readApprovedJapanTollfreeDateBetween: + value: '2022-11-29T23:59:59Z' - name: ValidUntilDate> in: query description: Date to filter Bundles having their `valid_until_date` before @@ -767,6 +1452,9 @@ paths: schema: type: string format: date-time + examples: + readApprovedJapanTollfreeDateBetween: + value: '2022-01-01T00:00:00Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -799,50 +1487,164 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: provisionally-approved + email: email + status_callback: http://www.example.com + valid_until: '2020-07-31T01:00:00Z' + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readApprovedAuMobileWithDate: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2022-11-29T01:00:00Z' + date_created: '2021-08-30T22:29:24Z' + date_updated: '2021-08-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readApprovedAuMobileDateLess: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2022-11-29T01:00:00Z' + date_created: '2021-08-30T22:29:24Z' + date_updated: '2021-08-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readApprovedJapanTollfreeDateBetween: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2022-11-29T01:00:00Z' + date_created: '2021-08-30T22:29:24Z' + date_updated: '2021-08-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListBundle - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - regulation_sid - friendly_name - pathType: instance dependentProperties: evaluation: '{bundle_sid: sid}' item_assignment: '{bundle_sid: sid}' bundle_copy: '{bundle_sid: sid}' replace_items: '{bundle_sid: sid}' parent: /RegulatoryCompliance + pathType: instance get: description: Fetch a specific Bundle instance. parameters: @@ -861,12 +1663,28 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' + examples: + fetch: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: null + email: email + status_callback: http://www.example.com + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies description: OK security: - accountSid_authToken: [] operationId: FetchBundle - x-maturity: - - GA post: description: Updates a Bundle in an account. parameters: @@ -885,12 +1703,28 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' + examples: + update: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments + bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies description: OK security: - accountSid_authToken: [] operationId: UpdateBundle - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -914,6 +1748,13 @@ paths: type: string description: The email address that will receive updates when the Bundle resource changes status. + examples: + update: + value: + Status: draft + StatusCallback: http://www.example.com + FriendlyName: friendly_name + Email: email delete: description: Delete a specific Bundle. parameters: @@ -932,17 +1773,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBundle - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} mountName: bundle_copies + pathType: list post: description: Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle @@ -962,12 +1801,23 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: '2015-07-30T20:00:00Z' + email: email + status_callback: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateBundleCopy - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -979,6 +1829,10 @@ paths: type: string description: The string that you assigned to describe the copied bundle. + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieve a list of all Bundles Copies for a Bundle. parameters: @@ -1023,44 +1877,241 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true + type: string url: + format: uri type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: twilio-approved + email: email + status_callback: http://www.example.com + valid_until: '2020-07-31T01:00:00Z' + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 + next_page_url: null + key: results + description: OK + security: + - accountSid_authToken: [] + operationId: ListBundleCopy + /v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /HostedNumber/AuthorizationDocuments/{Sid} + pathType: list + get: + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. + parameters: + - name: SigningDocumentSid + in: path + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + examples: + readEmpty: + value: example + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDependentHostedNumberOrderResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/numbers.v2.authorization_document.dependent_hosted_number_order' + meta: + properties: + first_page_url: format: uri + type: string key: type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + failure_reason: '' + contact_title: contact_title_test + contact_phone_number: '+12344444444' + bulk_hosting_request_sid: BHR1111111111111111111111111111111 + next_step: Test description: OK security: - accountSid_authToken: [] - operationId: ListBundleCopy - x-maturity: - - Beta + operationId: ListDependentHostedNumberOrder /v2/RegulatoryCompliance/EndUsers: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list post: description: Create a new End User. responses: @@ -1069,12 +2120,22 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' + examples: + create: + value: + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1096,6 +2157,12 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: friendly_name + Type: individual + Attributes: '{}' get: description: Retrieve a list of all End User for an account. parameters: @@ -1131,44 +2198,74 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListEndUser - x-maturity: - - GA /v2/RegulatoryCompliance/EndUsers/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch specific End User Instance. parameters: @@ -1188,12 +2285,22 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' + examples: + fetch: + value: + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEndUser - x-maturity: - - GA post: description: Update an existing End User. parameters: @@ -1213,12 +2320,22 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' + examples: + update: + value: + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + type: individual + attributes: + email: foobar@twilio.com + date_created: '2019-07-30T21:57:45Z' + date_updated: '2019-07-30T21:57:45Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1232,6 +2349,11 @@ paths: Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific End User. parameters: @@ -1251,18 +2373,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEndUser - x-maturity: - - GA /v2/RegulatoryCompliance/EndUserTypes: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list get: description: Retrieve a list of all End-User Types. parameters: @@ -1298,44 +2418,76 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + end_user_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types + readFull: + value: + end_user_types: + - sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + machine_name: machine_name + fields: + - friendly_name: Business Purpose + machine_name: business_purpose + constraint: String + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types description: OK security: - accountSid_authToken: [] operationId: ListEndUserType - x-maturity: - - GA /v2/RegulatoryCompliance/EndUserTypes/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch a specific End-User Type Instance. parameters: @@ -1351,21 +2503,33 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type' + examples: + fetch: + value: + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + machine_name: machine_name + fields: + - friendly_name: Business Purpose + machine_name: business_purpose + constraint: String + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEndUserType - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: list post: description: Creates an evaluation for a bundle parameters: @@ -1384,12 +2548,165 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' + examples: + create: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: Created security: - accountSid_authToken: [] operationId: CreateEvaluation - x-maturity: - - GA get: description: Retrieve a list of Evaluations associated to the Bundle resource. parameters: @@ -1434,43 +2751,216 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add + one to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the + Business information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter + in a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure + both Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in + the address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListEvaluation - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: instance get: description: Fetch specific Evaluation Instance. parameters: @@ -1498,21 +2988,608 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' + examples: + fetch: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: OK security: - accountSid_authToken: [] operationId: FetchEvaluation - x-maturity: - - GA + /v2/HostedNumber/Orders/{Sid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: hosted_number_orders + pathType: instance + get: + description: Fetch a specific HostedNumberOrder. + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.hosted_number_order' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + failure_reason: '' + bulk_hosting_request_sid: BHR1111111111111111111111111111111 + next_step: next_step + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_title: contact_title_test + contact_phone_number: '+12344444444' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchHostedNumberOrder + delete: + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteHostedNumberOrder + /v2/HostedNumber/Orders: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + mountName: hosted_number_orders + pathType: list + get: + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. + parameters: + - name: Status + in: query + description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. + schema: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: SmsCapability + in: query + description: Whether the SMS capability will be hosted on our platform. Can + be `true` of `false`. + schema: + type: boolean + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + examples: + readEmpty: + value: example + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListHostedNumberOrderResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/numbers.v2.hosted_number_order' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + failure_reason: '' + friendly_name: friendly_name + bulk_hosting_request_sid: BHR1111111111111111111111111111111 + next_step: next_step + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_title: contact_title_test + contact_phone_number: '+12344444444' + description: OK + security: + - accountSid_authToken: [] + operationId: ListHostedNumberOrder + post: + description: Host a phone number's capability on Twilio's platform. + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v2.hosted_number_order' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + bulk_hosting_request_sid: BHR1111111111111111111111111111111 + next_step: next_step + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_title: contact_title_test + contact_phone_number: '+12344444444' + createWithoutOptionalLoaFields: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + contact_title: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + bulk_hosting_request_sid: BHR1111111111111111111111111111111 + next_step: next_step + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_phone_number: '+12344444444' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateHostedNumberOrder + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateHostedNumberOrderRequest + properties: + PhoneNumber: + type: string + format: phone-number + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + ContactPhoneNumber: + type: string + format: phone-number + description: The contact phone number of the person authorized to + sign the Authorization Document. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + Email: + type: string + description: Optional. Email of the owner of this phone number that + is being hosted. + AccountSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + description: This defaults to the AccountSid of the authorization + the user is using. This can be provided to specify a subaccount + to add the HostedNumberOrder to. + FriendlyName: + type: string + description: A 64 character string that is a human readable text + that describes this resource. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + SmsUrl: + type: string + format: uri + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsUrl. Must be either `GET` or `POST`. This will be copied onto + the IncomingPhoneNumber resource. + SmsFallbackUrl: + type: string + format: uri + description: A URL that Twilio will request if an error occurs requesting + or executing the TwiML defined by SmsUrl. This will be copied + onto the IncomingPhoneNumber resource. + SmsCapability: + type: boolean + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied + onto the IncomingPhoneNumber resource. + StatusCallbackUrl: + type: string + format: uri + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + StatusCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + SmsApplicationSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + description: Optional. The 34 character sid of the application Twilio + should use to handle SMS messages sent to this number. If a `SmsApplicationSid` + is present, Twilio will ignore all of the SMS urls above and use + those set on the application. + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + required: + - PhoneNumber + - ContactPhoneNumber + - AddressSid + - Email + examples: + create: + value: + AddressSid: AD11111111111111111111111111111111 + PhoneNumber: '+14153608311' + ContactPhoneNumber: '+12344444444' + ContactTitle: contact_title_test + Email: test@twilio.com + createWithoutOptionalLoaFields: + value: + PhoneNumber: '+14153608311' + ContactPhoneNumber: '+12344444444' + Email: test@twilio.com + AddressSid: AD11111111111111111111111111111111 /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: list post: description: Create a new Assigned Item. parameters: @@ -1531,12 +3608,19 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' + examples: + create: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateItemAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1553,6 +3637,10 @@ paths: the different items. required: - ObjectSid + examples: + create: + value: + ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. parameters: @@ -1597,43 +3685,70 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListItemAssignment - x-maturity: - - GA /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /RegulatoryCompliance/Bundles/{Sid} + pathType: instance get: description: Fetch specific Assigned Item Instance. parameters: @@ -1661,12 +3776,19 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' + examples: + fetch: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchItemAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. parameters: @@ -1694,18 +3816,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteItemAssignment - x-maturity: - - GA /v2/RegulatoryCompliance/Regulations: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list get: description: Retrieve a list of all Regulations. parameters: @@ -1716,16 +3836,25 @@ paths: schema: type: string $ref: '#/components/schemas/regulation_enum_end_user_type' + examples: + readEmpty: + value: business - name: IsoCountry in: query description: The ISO country code of the phone number's country. schema: type: string + examples: + readEmpty: + value: US - name: NumberType in: query description: The type of phone number that the regulatory requiremnt is restricting. schema: type: string + examples: + readEmpty: + value: mobile - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1758,44 +3887,91 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&EndUserType=business&NumberType=mobile&PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&EndUserType=business&NumberType=mobile&PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 'Australia: Local - Individual' + iso_country: AU + number_type: local + end_user_type: individual + requirements: + end_user: + - name: Individual + type: individual + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual + fields: + - first_name + - last_name + supporting_document: + - - name: Address + type: document + description: The physical location of the individual or + business. Must be within locality or region covered + by the phone numbers prefix; a PO Box is not acceptable + where a local address is required. + accepted_documents: + - name: Address Validation + type: address + url: https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address + fields: [] + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListRegulation - x-maturity: - - GA /v2/RegulatoryCompliance/Regulations/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch specific Regulation Instance. parameters: @@ -1814,28 +3990,55 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation' + examples: + fetch: + value: + sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: 'Australia: Local - Individual' + iso_country: AU + number_type: local + end_user_type: individual + requirements: + end_user: + - name: Individual + type: individual + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual + fields: + - first_name + - last_name + supporting_document: + - - name: Address + type: document + description: The physical location of the individual or + business. Must be within locality or region covered by + the phone numbers prefix; a PO Box is not acceptable where + a local address is required. + accepted_documents: + - name: Address Validation + type: address + url: https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address + fields: [] + url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRegulation - x-maturity: - - GA /v2/RegulatoryCompliance: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list /v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /RegulatoryCompliance/Bundles/{Sid} className: replace_items + pathType: list post: description: Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid @@ -1857,12 +4060,23 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.replace_items' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: '2015-07-30T20:00:00Z' + email: email + status_callback: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateReplaceItems - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1879,16 +4093,20 @@ paths: from. required: - FromBundleSid + examples: + create: + value: + FromBundleSid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb /v2/RegulatoryCompliance/SupportingDocuments: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list post: description: Create a new Supporting Document. responses: @@ -1897,12 +4115,26 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' + examples: + create: + value: + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1923,6 +4155,12 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: friendly_name + Type: type + Attributes: '{}' get: description: Retrieve a list of all Supporting Document for an account. parameters: @@ -1958,44 +4196,102 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results + readRejectedDocument: + value: + results: + - sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: twilio-rejected + failure_reason: Some failure reason. + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocument - x-maturity: - - GA /v2/RegulatoryCompliance/SupportingDocuments/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch specific Supporting Document Instance. parameters: @@ -2015,12 +4311,26 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' + examples: + fetch: + value: + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocument - x-maturity: - - GA post: description: Update an existing Supporting Document. parameters: @@ -2040,12 +4350,26 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' + examples: + update: + value: + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + mime_type: mime_type + status: draft + failure_reason: null + type: type + attributes: + first_name: foo + last_name: bar + date_created: '2019-07-31T02:11:52Z' + date_updated: '2019-07-31T02:11:52Z' + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2060,6 +4384,11 @@ paths: description: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific Supporting Document. parameters: @@ -2079,18 +4408,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSupportingDocument - x-maturity: - - GA /v2/RegulatoryCompliance/SupportingDocumentTypes: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list parent: /RegulatoryCompliance + pathType: list get: description: Retrieve a list of all Supporting Document Types. parameters: @@ -2126,44 +4453,73 @@ paths: items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + supporting_document_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types + readFull: + value: + supporting_document_types: + - sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Passport + machine_name: passport + fields: + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocumentType - x-maturity: - - GA /v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}: servers: - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance parent: /RegulatoryCompliance + pathType: instance get: description: Fetch a specific Supporting Document Type Instance. parameters: @@ -2180,17 +4536,20 @@ paths: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type' + examples: + fetch: + value: + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Passport + machine_name: passport + fields: + - friendly_name: Last Name + machine_name: last_name + constraint: String + url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocumentType - x-maturity: - - GA servers: - url: https://numbers.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_oauth_v1.yaml b/spec/yaml/twilio_oauth_v1.yaml index 456c5b4a..ecd77d42 100644 --- a/spec/yaml/twilio_oauth_v1.yaml +++ b/spec/yaml/twilio_oauth_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: oauth.v1.certs: type: object @@ -185,10 +189,6 @@ components: type: string format: uri nullable: true - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Oauth description: This is the public Twilio REST API. @@ -200,18 +200,18 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/certs: servers: - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - keys - pathType: instance mountName: oauth + pathType: instance get: description: Fetches public JWKs responses: @@ -220,16 +220,27 @@ paths: application/json: schema: $ref: '#/components/schemas/oauth.v1.certs' + examples: + fetch: + value: + keys: + - alg: ES256 + kid: IC10c8172f35dd36f20d9ed2fcc0b818c7 + key_ops: [] + use: sig + crv: P-256 + x: hrJ4NKauVYBiREgIY_EPPj10zHIiOHeIf3-LGODt_KM + y: c3IcyhpvfMIMpqd_ku9Q_4n20nMlelUF-zSmRXEIFEU + kty: EC + url: https://oauth.twilio.com/v1/certs description: OK security: - accountSid_authToken: [] operationId: FetchCerts - x-maturity: - - GA /v1/device/code: servers: - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - device_code @@ -238,8 +249,8 @@ paths: - verification_uri_complete - expires_in - interval - pathType: list mountName: device_code + pathType: list post: description: Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant @@ -249,12 +260,19 @@ paths: application/json: schema: $ref: '#/components/schemas/oauth.v1.device_code' + examples: + create: + value: + device_code: LiwuhE0bIhqemK6sd34tXfobVCR9yrk0 + user_code: Hkf1WaID3 + verification_uri: v1/oauth2/device/activate + verification_uri_complete: v1/oauth2/device/activate?user_code=Hkf1WaID3 + expires_in: 299 + interval: 5 description: Created security: - accountSid_authToken: [] operationId: CreateDeviceCode - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -279,10 +297,18 @@ paths: required: - ClientSid - Scopes + examples: + create: + value: + ClientSid: OQ693217fa7610373e7762f06645058bac + Scopes: + - test-scope + Audiences: + - http://dev.twilio.com/ /v1/.well-known/openid-configuration: servers: - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - issuer @@ -297,8 +323,8 @@ paths: - id_token_signing_alg_values_supported - scopes_supported - claims_supported - pathType: instance mountName: openid_discovery + pathType: instance get: description: Fetch configuration details about the OpenID Connect Authorization Server @@ -308,16 +334,50 @@ paths: application/json: schema: $ref: '#/components/schemas/oauth.v1.openid_discovery' + examples: + fetch: + value: + issuer: https://iam.twilio.com + authorization_endpoint: https://oauth.twilio.com/oauth2/authorize + device_authorization_endpoint: https://oauth.twilio.com/oauth2/device/authorize + token_endpoint: https://oauth.twilio.com/oauth2/token + userinfo_endpoint: https://oauth.twilio.com/oauth2/userinfo + revocation_endpoint: https://oauth.twilio.com/oauth2/revoke + jwk_uri: https://oauth.twilio.com/oauth2/certs + response_type_supported: + - code + - token + subject_type_supported: + - account_sid + - user_sid + id_token_signing_alg_values_supported: + - ECDSA + - RSA256 + scopes_supported: + - openid + - profile + - email + claims_supported: + - act + - aud + - cid + - device_id + - exp + - jti + - iat + - iss + - nbf + - scp + - sub + url: https://oauth.twilio.com/v1/.well-known/openid-configuration description: OK security: - accountSid_authToken: [] operationId: FetchOpenidDiscovery - x-maturity: - - GA /v1/token: servers: - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - access_token @@ -332,12 +392,18 @@ paths: application/json: schema: $ref: '#/components/schemas/oauth.v1.token' + examples: + create: + value: + access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + refresh_token: ghjbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + id_token: eyJhbdGciOiIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + refresh_token_expires_at: '2015-07-31T04:00:00Z' + access_token_expires_at: '2015-07-31T04:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateToken - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -375,15 +441,26 @@ paths: required: - GrantType - ClientSid + examples: + create: + value: + GrantType: authorization_code + ClientSid: OQ09708361261756db8c0b555d36f55a65 + ClientSecret: client_secret + Code: dfyguyhuijikokje456rt7y8uioklj + CodeVerifier: code_verifier + DeviceCode: device_code + RefreshToken: refresh_token + DeviceId: device_id /v1/userinfo: servers: - url: https://oauth.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - user_sid - pathType: instance mountName: user_info + pathType: instance get: description: Retrieves the consented UserInfo and other claims about the logged-in subject (end-user). @@ -393,14 +470,18 @@ paths: application/json: schema: $ref: '#/components/schemas/oauth.v1.user_info' + examples: + fetch: + value: + user_sid: US57cc2449f1b38ed85cf1a43cd8166349 + first_name: Mafalda + last_name: Rolfson + friendly_name: mafalda.rolfson+oBgz@ct.sink.twilio.com + email: mafalda.rolfson+oBgz@ct.sink.twilio.com + url: https://oauth.twilio.com/v1/userinfo description: OK security: - accountSid_authToken: [] operationId: FetchUserInfo - x-maturity: - - GA servers: - url: https://oauth.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index 7f46fd50..9463118c 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: preview.deployed_devices.fleet.certificate: type: object @@ -308,739 +312,333 @@ components: nullable: true description: Specifies the date this Key credential was last updated, given in UTC ISO 8601 format. - preview.hosted_numbers.authorization_document: + preview.marketplace.available_add_on: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this AuthorizationDocument. - address_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the Address - resource that is associated with this AuthorizationDocument. - status: + description: The unique string that we created to identify the AvailableAddOn + resource. + friendly_name: type: string - $ref: '#/components/schemas/authorization_document_enum_status' nullable: true - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - email: + description: The string that you assigned to describe the resource. + description: type: string nullable: true - description: Email that this AuthorizationDocument will be sent to for signing. - cc_emails: - type: array - items: - type: string - nullable: true - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - date_created: + description: A short description of the Add-on's functionality. + pricing_type: type: string - format: date-time nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. - date_updated: - type: string - format: date-time + description: How customers are charged for using this Add-on. + configuration_schema: nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + description: The JSON object with the configuration that must be provided + when installing a given Add-on. url: type: string format: uri nullable: true + description: The absolute URL of the resource. links: type: object format: uri-map nullable: true - authorization_document_enum_status: - type: string - enum: - - opened - - signing - - signed - - canceled - - failed - preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + description: The URLs of related resources. + preview.marketplace.available_add_on.available_add_on_extension: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this Authorization - Document - account_sid: + description: The unique string that we created to identify the AvailableAddOnExtension + resource. + available_add_on_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ nullable: true - description: The unique SID identifier of the Account. - incoming_phone_number_sid: + description: The SID of the AvailableAddOn resource to which this extension + applies. + friendly_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - address_sid: + description: The string that you assigned to describe the resource. + product_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the Address - resource that represents the address of the owner of this phone number. - signing_document_sid: + description: The name of the Product this Extension is used within. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the resource. + preview.marketplace.installed_add_on: + type: object + properties: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the LOA document - associated with this HostedNumberOrder. - phone_number: + description: The unique string that we created to identify the InstalledAddOn + resource. This Sid can also be found in the Console on that specific Add-ons + page as the 'Available Add-on Sid'. + account_sid: type: string - format: phone-number - nullable: true - description: An E164 formatted phone number hosted by this HostedNumberOrder. - capabilities: - type: object - format: phone-number-capabilities - properties: - mms: - type: boolean - sms: - type: boolean - voice: - type: boolean - fax: - type: boolean + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A mapping of capabilities this hosted phone number will have - enabled on Twilio's platform. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the InstalledAddOn resource. friendly_name: type: string nullable: true - description: A human readable description of this resource, up to 64 characters. - unique_name: + description: The string that you assigned to describe the resource. + description: type: string nullable: true - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in - addition to SID. - status: - type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + description: A short description of the Add-on's functionality. + configuration: nullable: true - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - failure_reason: + description: The JSON object that represents the current configuration of + installed Add-on. + unique_name: type: string nullable: true - description: A message that explains why a hosted_number_order went to status - "action-required" + description: An application-defined string that uniquely identifies the + resource. date_created: type: string format: date-time nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - verification_attempts: - type: integer - nullable: true - description: The number of attempts made to verify ownership of the phone - number that is being hosted. - email: + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: type: string + format: uri nullable: true - description: Email of the owner of this phone number that is being hosted. - cc_emails: - type: array - items: - type: string + description: The absolute URL of the resource. + links: + type: object + format: uri-map nullable: true - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - verification_type: + description: The URLs of related resources. + preview.marketplace.installed_add_on.installed_add_on_extension: + type: object + properties: + sid: type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ nullable: true - description: The method used for verifying ownership of the number to be - hosted. One of phone-call (default) or phone-bill. - verification_document_sid: + description: The unique string that we created to identify the InstalledAddOn + Extension resource. + installed_add_on_sid: type: string minLength: 34 maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the Identity - Document resource that represents the document for verifying ownership - of the number to be hosted. - extension: + description: The SID of the InstalledAddOn resource to which this extension + applies. + friendly_name: type: string nullable: true - description: A numerical extension to be used when making the ownership - verification call. - call_delay: - type: integer + description: The string that you assigned to describe the resource. + product_name: + type: string nullable: true - description: A value between 0-30 specifying the number of seconds to delay - initiating the ownership verification call. - verification_code: + description: The name of the Product this Extension is used within. + unique_name: type: string nullable: true - description: The digits passed during the ownership verification call. - verification_call_sids: - type: array - items: - type: string + description: An application-defined string that uniquely identifies the + resource. + enabled: + type: boolean nullable: true - description: A list of 34 character strings that are unique identifiers - for the calls placed as part of ownership verification. - dependent_hosted_number_order_enum_status: - type: string - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - dependent_hosted_number_order_enum_verification_type: - type: string - enum: - - phone-call - - phone-bill - preview.hosted_numbers.hosted_number_order: + description: Whether the Extension will be invoked. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the resource. + preview.sync.service.document: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies this HostedNumberOrder. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the account. - incoming_phone_number_sid: + unique_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) - resource that represents the phone number being hosted. - address_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the Address - resource that represents the address of the owner of this phone number. - signing_document_sid: + service_sid: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies the [Authorization - Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) - the user needs to sign. - phone_number: + url: type: string - format: phone-number + format: uri nullable: true - description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) - format, e.g., +16175551212 - capabilities: + links: type: object - format: phone-number-capabilities - properties: - mms: - type: boolean - sms: - type: boolean - voice: - type: boolean - fax: - type: boolean - nullable: true - description: Set of booleans describing the capabilities hosted on Twilio's - platform. SMS is currently only supported. - friendly_name: - type: string - nullable: true - description: A 64 character string that is a human-readable text that describes - this resource. - unique_name: - type: string + format: uri-map nullable: true - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in - addition to SID. - status: + revision: type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' nullable: true - description: 'Status of this resource. It can hold one of the values: 1. - Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, - 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders - Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) - section for more information on each of these statuses.' - failure_reason: - type: string + data: nullable: true - description: A message that explains why a hosted_number_order went to status - "action-required" date_created: type: string format: date-time nullable: true - description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) - format. date_updated: type: string format: date-time nullable: true - description: The date that this resource was updated, given as [GMT RFC - 2822](http://www.ietf.org/rfc/rfc2822.txt) format. - verification_attempts: - type: integer - nullable: true - description: The number of attempts made to verify ownership of the phone - number that is being hosted. - email: - type: string - nullable: true - description: Email of the owner of this phone number that is being hosted. - cc_emails: - type: array - items: - type: string - nullable: true - description: A list of emails that LOA document for this HostedNumberOrder - will be carbon copied to. - url: - type: string - format: uri - nullable: true - description: The URL of this HostedNumberOrder. - verification_type: + created_by: type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' nullable: true - description: The type of ownership verification required to move the number - to a `verified` state. The verification methods are `phone-call` or `phone-bill`. - verification_document_sid: + preview.sync.service.document.document_permission: + type: object + properties: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - nullable: true - description: A 34 character string that uniquely identifies the Identity - Document resource that represents the document for verifying ownership - of the number to be hosted. - extension: - type: string - nullable: true - description: A numerical extension to be used when making the ownership - verification call. - call_delay: - type: integer + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A value between 0-30 specifying the number of seconds to delay - initiating the ownership verification call. - verification_code: + description: The unique SID identifier of the Twilio Account. + service_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: A verification code provided in the response for a user to - enter when they pick up the phone call. - verification_call_sids: - type: array - items: - type: string - nullable: true - description: A list of 34 character strings that are unique identifiers - for the calls placed as part of ownership verification. - hosted_number_order_enum_status: - type: string - enum: - - received - - pending-verification - - verified - - pending-loa - - carrier-processing - - testing - - completed - - failed - - action-required - hosted_number_order_enum_verification_type: - type: string - enum: - - phone-call - - phone-bill - preview.marketplace.available_add_on: - type: object - properties: - sid: + description: The unique SID identifier of the Sync Service Instance. + document_sid: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^ET[0-9a-fA-F]{32}$ nullable: true - description: The unique string that we created to identify the AvailableAddOn - resource. - friendly_name: + description: The unique SID identifier of the Sync Document to which the + Permission applies. + identity: type: string nullable: true - description: The string that you assigned to describe the resource. - description: - type: string + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + read: + type: boolean nullable: true - description: A short description of the Add-on's functionality. - pricing_type: - type: string + description: Boolean flag specifying whether the identity can read the Sync + Document. + write: + type: boolean nullable: true - description: How customers are charged for using this Add-on. - configuration_schema: + description: Boolean flag specifying whether the identity can update the + Sync Document. + manage: + type: boolean nullable: true - description: The JSON object with the configuration that must be provided - when installing a given Add-on. + description: Boolean flag specifying whether the identity can delete the + Sync Document. url: type: string format: uri nullable: true - description: The absolute URL of the resource. - links: - type: object - format: uri-map - nullable: true - description: The URLs of related resources. - preview.marketplace.available_add_on.available_add_on_extension: + description: Contains an absolute URL for this Sync Document Permission. + preview.sync.service: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ nullable: true - description: The unique string that we created to identify the AvailableAddOnExtension - resource. - available_add_on_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The SID of the AvailableAddOn resource to which this extension - applies. friendly_name: type: string nullable: true - description: The string that you assigned to describe the resource. - product_name: + date_created: type: string + format: date-time nullable: true - description: The name of the Product this Extension is used within. - unique_name: + date_updated: type: string + format: date-time nullable: true - description: An application-defined string that uniquely identifies the - resource. url: type: string format: uri nullable: true - description: The absolute URL of the resource. - preview.marketplace.installed_add_on: + webhook_url: + type: string + format: uri + nullable: true + reachability_webhooks_enabled: + type: boolean + nullable: true + acl_enabled: + type: boolean + nullable: true + links: + type: object + format: uri-map + nullable: true + preview.sync.service.sync_list: type: object properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the InstalledAddOn - resource. This Sid can also be found in the Console on that specific Add-ons - page as the 'Available Add-on Sid'. - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the InstalledAddOn resource. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. - description: - type: string - nullable: true - description: A short description of the Add-on's functionality. - configuration: - nullable: true - description: The JSON object that represents the current configuration of - installed Add-on. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. - date_created: - type: string - format: date-time - nullable: true - description: The date and time in GMT when the resource was created specified - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - date_updated: - type: string - format: date-time - nullable: true - description: The date and time in GMT when the resource was last updated - specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the resource. - links: - type: object - format: uri-map - nullable: true - description: The URLs of related resources. - preview.marketplace.installed_add_on.installed_add_on_extension: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - nullable: true - description: The unique string that we created to identify the InstalledAddOn - Extension resource. - installed_add_on_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the InstalledAddOn resource to which this extension - applies. - friendly_name: - type: string - nullable: true - description: The string that you assigned to describe the resource. - product_name: - type: string - nullable: true - description: The name of the Product this Extension is used within. - unique_name: - type: string - nullable: true - description: An application-defined string that uniquely identifies the - resource. - enabled: - type: boolean - nullable: true - description: Whether the Extension will be invoked. - url: - type: string - format: uri - nullable: true - description: The absolute URL of the resource. - preview.sync.service.document: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - nullable: true - unique_name: - type: string - nullable: true - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - service_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - nullable: true - url: - type: string - format: uri - nullable: true - links: - type: object - format: uri-map - nullable: true - revision: - type: string - nullable: true - data: - nullable: true - date_created: - type: string - format: date-time - nullable: true - date_updated: - type: string - format: date-time - nullable: true - created_by: - type: string - nullable: true - preview.sync.service.document.document_permission: - type: object - properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique SID identifier of the Twilio Account. - service_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - nullable: true - description: The unique SID identifier of the Sync Service Instance. - document_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^ET[0-9a-fA-F]{32}$ - nullable: true - description: The unique SID identifier of the Sync Document to which the - Permission applies. - identity: - type: string - nullable: true - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - read: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can read the Sync - Document. - write: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can update the - Sync Document. - manage: - type: boolean - nullable: true - description: Boolean flag specifying whether the identity can delete the - Sync Document. - url: - type: string - format: uri - nullable: true - description: Contains an absolute URL for this Sync Document Permission. - preview.sync.service: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - nullable: true - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - friendly_name: - type: string - nullable: true - date_created: - type: string - format: date-time - nullable: true - date_updated: - type: string - format: date-time - nullable: true - url: - type: string - format: uri - nullable: true - webhook_url: - type: string - format: uri - nullable: true - reachability_webhooks_enabled: - type: boolean - nullable: true - acl_enabled: - type: boolean - nullable: true - links: - type: object - format: uri-map - nullable: true - preview.sync.service.sync_list: - type: object - properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^ES[0-9a-fA-F]{32}$ - nullable: true - unique_name: - type: string + pattern: ^ES[0-9a-fA-F]{32}$ + nullable: true + unique_name: + type: string nullable: true account_sid: type: string @@ -2245,32 +1843,434 @@ components: type: string format: uri nullable: true - securitySchemes: - accountSid_authToken: - type: http - scheme: basic -info: - title: Twilio - Preview - description: This is the public Twilio REST API. - termsOfService: https://www.twilio.com/legal/tos - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 + preview.hosted_numbers.authorization_document: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this AuthorizationDocument. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that is associated with this AuthorizationDocument. + status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + nullable: true + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + email: + type: string + nullable: true + description: Email that this AuthorizationDocument will be sent to for signing. + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + url: + type: string + format: uri + nullable: true + links: + type: object + format: uri-map + nullable: true + authorization_document_enum_status: + type: string + enum: + - opened + - signing + - signed + - canceled + - failed + preview.hosted_numbers.authorization_document.dependent_hosted_number_order: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this Authorization + Document + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique SID identifier of the Account. + incoming_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + phone_number: + type: string + format: phone-number + nullable: true + description: An E164 formatted phone number hosted by this HostedNumberOrder. + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean + nullable: true + description: A mapping of capabilities this hosted phone number will have + enabled on Twilio's platform. + friendly_name: + type: string + nullable: true + description: A human readable description of this resource, up to 64 characters. + unique_name: + type: string + nullable: true + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in + addition to SID. + status: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + nullable: true + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + failure_reason: + type: string + nullable: true + description: A message that explains why a hosted_number_order went to status + "action-required" + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + verification_attempts: + type: integer + nullable: true + description: The number of attempts made to verify ownership of the phone + number that is being hosted. + email: + type: string + nullable: true + description: Email of the owner of this phone number that is being hosted. + cc_emails: + type: array + items: + type: string + nullable: true + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + verification_type: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' + nullable: true + description: The method used for verifying ownership of the number to be + hosted. One of phone-call (default) or phone-bill. + verification_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Identity + Document resource that represents the document for verifying ownership + of the number to be hosted. + extension: + type: string + nullable: true + description: A numerical extension to be used when making the ownership + verification call. + call_delay: + type: integer + nullable: true + description: A value between 0-30 specifying the number of seconds to delay + initiating the ownership verification call. + verification_code: + type: string + nullable: true + description: The digits passed during the ownership verification call. + verification_call_sids: + type: array + items: + type: string + nullable: true + description: A list of 34 character strings that are unique identifiers + for the calls placed as part of ownership verification. + dependent_hosted_number_order_enum_status: + type: string + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + dependent_hosted_number_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill + preview.hosted_numbers.hosted_number_order: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this HostedNumberOrder. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the account. + incoming_phone_number_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) + resource that represents the phone number being hosted. + address_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Address + resource that represents the address of the owner of this phone number. + signing_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the [Authorization + Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) + the user needs to sign. + phone_number: + type: string + format: phone-number + nullable: true + description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) + format, e.g., +16175551212 + capabilities: + type: object + format: phone-number-capabilities + properties: + mms: + type: boolean + sms: + type: boolean + voice: + type: boolean + fax: + type: boolean + nullable: true + description: Set of booleans describing the capabilities hosted on Twilio's + platform. SMS is currently only supported. + friendly_name: + type: string + nullable: true + description: A 64 character string that is a human-readable text that describes + this resource. + unique_name: + type: string + nullable: true + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in + addition to SID. + status: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + nullable: true + description: 'Status of this resource. It can hold one of the values: 1. + Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, + 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders + Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) + section for more information on each of these statuses.' + failure_reason: + type: string + nullable: true + description: A message that explains why a hosted_number_order went to status + "action-required" + date_created: + type: string + format: date-time + nullable: true + description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) + format. + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was updated, given as [GMT RFC + 2822](http://www.ietf.org/rfc/rfc2822.txt) format. + verification_attempts: + type: integer + nullable: true + description: The number of attempts made to verify ownership of the phone + number that is being hosted. + email: + type: string + nullable: true + description: Email of the owner of this phone number that is being hosted. + cc_emails: + type: array + items: + type: string + nullable: true + description: A list of emails that LOA document for this HostedNumberOrder + will be carbon copied to. + url: + type: string + format: uri + nullable: true + description: The URL of this HostedNumberOrder. + verification_type: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + nullable: true + description: The type of ownership verification required to move the number + to a `verified` state. The verification methods are `phone-call` or `phone-bill`. + verification_document_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies the Identity + Document resource that represents the document for verifying ownership + of the number to be hosted. + extension: + type: string + nullable: true + description: A numerical extension to be used when making the ownership + verification call. + call_delay: + type: integer + nullable: true + description: A value between 0-30 specifying the number of seconds to delay + initiating the ownership verification call. + verification_code: + type: string + nullable: true + description: A verification code provided in the response for a user to + enter when they pick up the phone call. + verification_call_sids: + type: array + items: + type: string + nullable: true + description: A list of 34 character strings that are unique identifiers + for the calls placed as part of ownership verification. + hosted_number_order_enum_status: + type: string + enum: + - received + - pending-verification + - verified + - pending-loa + - carrier-processing + - testing + - completed + - failed + - action-required + hosted_number_order_enum_verification_type: + type: string + enum: + - phone-call + - phone-bill +info: + title: Twilio - Preview + description: This is the public Twilio REST API. + termsOfService: https://www.twilio.com/legal/tos + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Fleets/{Sid} + pathType: instance get: description: Fetch information about a specific Certificate credential in the Fleet. @@ -2297,12 +2297,22 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + examples: + fetch: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchDeployedDevicesCertificate - x-maturity: - - Preview delete: description: Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it. @@ -2329,8 +2339,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeployedDevicesCertificate - x-maturity: - - Preview post: description: Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device. @@ -2357,12 +2365,22 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + examples: + update: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateDeployedDevicesCertificate - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2381,14 +2399,19 @@ paths: pattern: ^TH[0-9a-fA-F]{32}$ description: Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential. + examples: + update: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name /DeployedDevices/Fleets/{FleetSid}/Certificates: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Fleets/{Sid} + pathType: list post: description: Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device. @@ -2405,12 +2428,22 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + examples: + create: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateDeployedDevicesCertificate - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2435,6 +2468,12 @@ paths: Device to become authenticated with this Certificate credential. required: - CertificateData + examples: + create: + value: + CertificateData: 12345678abcdef + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: description: Retrieve a list of all Certificate credentials belonging to the Fleet. @@ -2486,42 +2525,72 @@ paths: items: $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + certificates: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + readFull: + value: + certificates: + - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDeployedDevicesCertificate - x-maturity: - - Preview /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Fleets/{Sid} + pathType: instance get: description: Fetch information about a specific Deployment in the Fleet. parameters: @@ -2547,12 +2616,21 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + examples: + fetch: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchDeployedDevicesDeployment - x-maturity: - - Preview delete: description: Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed. @@ -2579,8 +2657,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeployedDevicesDeployment - x-maturity: - - Preview post: description: Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync @@ -2608,12 +2684,21 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + examples: + update: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateDeployedDevicesDeployment - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2633,14 +2718,19 @@ paths: description: Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment. + examples: + update: + value: + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid /DeployedDevices/Fleets/{FleetSid}/Deployments: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Fleets/{Sid} + pathType: list post: description: Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance. @@ -2657,12 +2747,21 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + examples: + create: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateDeployedDevicesDeployment - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2682,6 +2781,11 @@ paths: description: Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment. + examples: + create: + value: + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid get: description: Retrieve a list of all Deployments belonging to the Fleet. parameters: @@ -2723,42 +2827,71 @@ paths: items: $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + deployments: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + readFull: + value: + deployments: + - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDeployedDevicesDeployment - x-maturity: - - Preview /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Fleets/{Sid} + pathType: instance get: description: Fetch information about a specific Device in the Fleet. parameters: @@ -2781,12 +2914,25 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + fetch: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchDeployedDevicesDevice - x-maturity: - - Preview delete: description: Delete a specific Device from the Fleet, also removing it from associated Deployments. @@ -2810,8 +2956,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeployedDevicesDevice - x-maturity: - - Preview post: description: Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity. @@ -2835,12 +2979,25 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + update: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateDeployedDevicesDevice - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2867,14 +3024,19 @@ paths: Enabled: type: boolean description: '' + examples: + update: + value: + FriendlyName: friendly_name + Identity: identity /DeployedDevices/Fleets/{FleetSid}/Devices: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Fleets/{Sid} + pathType: list post: description: Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity. @@ -2891,12 +3053,25 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + examples: + create: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateDeployedDevicesDevice - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -2928,6 +3103,12 @@ paths: Enabled: type: boolean description: '' + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Identity: identity get: description: Retrieve a list of all Devices belonging to the Fleet. parameters: @@ -2978,46 +3159,79 @@ paths: items: $ref: '#/components/schemas/preview.deployed_devices.fleet.device' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + devices: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + readFull: + value: + devices: + - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDeployedDevicesDevice - x-maturity: - - Preview /DeployedDevices/Fleets/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: device: '{fleet_sid: sid}' deployment: '{fleet_sid: sid}' certificate: '{fleet_sid: sid}' key: '{fleet_sid: sid}' + pathType: instance get: description: Fetch information about a specific Fleet in your account. parameters: @@ -3034,12 +3248,26 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet' + examples: + fetch: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: OK security: - accountSid_authToken: [] operationId: FetchDeployedDevicesFleet - x-maturity: - - Preview delete: description: 'Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.' @@ -3057,8 +3285,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeployedDevicesFleet - x-maturity: - - Preview post: description: Update the friendly name property of a specific Fleet in your account. parameters: @@ -3075,12 +3301,26 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet' + examples: + update: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: OK security: - accountSid_authToken: [] operationId: UpdateDeployedDevicesFleet - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3099,18 +3339,23 @@ paths: pattern: ^DL[0-9a-fA-F]{32}$ description: Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet. + examples: + update: + value: + FriendlyName: friendly_name + DefaultDeploymentSid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /DeployedDevices/Fleets: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: device: '{fleet_sid: sid}' deployment: '{fleet_sid: sid}' certificate: '{fleet_sid: sid}' key: '{fleet_sid: sid}' + pathType: list post: description: Create a new Fleet for scoping of deployed devices within your account. @@ -3120,12 +3365,26 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet' + examples: + create: + value: + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: Created security: - accountSid_authToken: [] operationId: CreateDeployedDevicesFleet - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3137,6 +3396,10 @@ paths: type: string description: Provides a human readable descriptive text for this Fleet, up to 256 characters long. + examples: + create: + value: + FriendlyName: friendly_name get: description: Retrieve a list of all Fleets belonging to your account. parameters: @@ -3172,42 +3435,76 @@ paths: items: $ref: '#/components/schemas/preview.deployed_devices.fleet' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + fleets: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + readFull: + value: + fleets: + - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDeployedDevicesFleet - x-maturity: - - Preview /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Fleets/{Sid} + pathType: instance get: description: Fetch information about a specific Key credential in the Fleet. parameters: @@ -3233,12 +3530,22 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + fetch: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchDeployedDevicesKey - x-maturity: - - Preview delete: description: Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it. @@ -3265,8 +3572,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDeployedDevicesKey - x-maturity: - - Preview post: description: Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device. @@ -3293,12 +3598,22 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + update: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateDeployedDevicesKey - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3317,14 +3632,19 @@ paths: pattern: ^TH[0-9a-fA-F]{32}$ description: Provides the unique string identifier of an existing Device to become authenticated with this Key credential. + examples: + update: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name /DeployedDevices/Fleets/{FleetSid}/Keys: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list parent: /Fleets/{Sid} + pathType: list post: description: Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device. @@ -3341,12 +3661,22 @@ paths: application/json: schema: $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + create: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateDeployedDevicesKey - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -3365,6 +3695,11 @@ paths: pattern: ^TH[0-9a-fA-F]{32}$ description: Provides the unique string identifier of an existing Device to become authenticated with this Key credential. + examples: + create: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: description: Retrieve a list of all Keys credentials belonging to the Fleet. parameters: @@ -3415,164 +3750,291 @@ paths: items: $ref: '#/components/schemas/preview.deployed_devices.fleet.key' meta: - type: object properties: first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri type: string + type: object + examples: + readEmpty: + value: + keys: [] + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + readFull: + value: + keys: + - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + description: OK + security: + - accountSid_authToken: [] + operationId: ListDeployedDevicesKey + /marketplace/AvailableAddOns/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + available_add_on_extension: '{available_add_on_sid: sid}' + pathType: instance + get: + description: Fetch an instance of an Add-on currently available to be installed. + parameters: + - name: Sid + in: path + description: The SID of the AvailableAddOn resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + examples: + fetch: + value: + sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceAvailableAddOn + /marketplace/AvailableAddOns: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + available_add_on_extension: '{available_add_on_sid: sid}' + pathType: list + get: + description: Retrieve a list of Add-ons currently available to be installed. + parameters: + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListMarketplaceAvailableAddOnResponse + properties: + available_add_ons: + type: array + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + meta: + properties: + first_page_url: format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + available_add_ons: + - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons + readEmpty: + value: + available_add_ons: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesKey - x-maturity: - - Preview - /HostedNumbers/AuthorizationDocuments/{Sid}: + operationId: ListMarketplaceAvailableAddOn + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension pathType: instance - dependentProperties: - dependent_hosted_number_order: '{signing_document_sid: sid}' get: - description: Fetch a specific AuthorizationDocument. + description: Fetch an instance of an Extension for the Available Add-on. parameters: - - name: Sid + - name: AvailableAddOnSid in: path - description: A 34 character string that uniquely identifies this AuthorizationDocument. + description: The SID of the AvailableAddOn resource with the extension to + fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchHostedNumbersAuthorizationDocument - x-maturity: - - Preview - post: - description: Updates a specific AuthorizationDocument. - parameters: - name: Sid in: path - description: '' + description: The SID of the AvailableAddOn Extension resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateHostedNumbersAuthorizationDocument - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - Status: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - description: 'Status of an instance resource. It can hold one of - the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, - 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - /HostedNumbers/AuthorizationDocuments: + operationId: FetchMarketplaceAvailableAddOnExtension + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension pathType: list - dependentProperties: - dependent_hosted_number_order: '{signing_document_sid: sid}' get: - description: Retrieve a list of AuthorizationDocuments belonging to the account - initiating the request. + description: Retrieve a list of Extensions for the Available Add-on. parameters: - - name: Email - in: query - description: Email that this AuthorizationDocument will be sent to for signing. - schema: - type: string - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' + - name: AvailableAddOnSid + in: path + description: The SID of the AvailableAddOn resource with the extensions to + read. schema: type: string - $ref: '#/components/schemas/authorization_document_enum_status' + minLength: 34 + maxLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3598,158 +4060,141 @@ paths: application/json: schema: type: object - title: ListHostedNumbersAuthorizationDocumentResponse + title: ListMarketplaceAvailableAddOnExtensionResponse properties: - items: + extensions: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: + value: + extensions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersAuthorizationDocument - x-maturity: - - Preview + operationId: ListMarketplaceAvailableAddOnExtension + /marketplace/InstalledAddOns: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + installed_add_on_extension: '{installed_add_on_sid: sid}' + pathType: list post: - description: Create an AuthorizationDocument for authorizing the hosting of - phone number capabilities on Twilio's platform. + description: Install an Add-on for the Account specified. responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + create: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_1 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateHostedNumbersAuthorizationDocument - x-maturity: - - Preview + operationId: CreateMarketplaceInstalledAddOn requestBody: content: application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - required: - - HostedNumberOrderSids - - AddressSid - - Email - - ContactTitle - - ContactPhoneNumber - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /AuthorizationDocuments/{Sid} - get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. - parameters: - - name: SigningDocumentSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - required: true - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string + schema: + type: object + title: CreateMarketplaceInstalledAddOnRequest + properties: + AvailableAddOnSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + description: The SID of the AvaliableAddOn to install. + AcceptTermsOfService: + type: boolean + description: Whether the Terms of Service were accepted. + Configuration: + description: The JSON object that represents the configuration of + the new Add-on being installed. + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + required: + - AvailableAddOnSid + - AcceptTermsOfService + examples: + create: + value: + AvailableAddOnSid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AcceptTermsOfService: true + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_1 + get: + description: Retrieve a list of Add-ons currently installed on this Account. + parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3775,220 +4220,329 @@ paths: application/json: schema: type: object - title: ListHostedNumbersDependentHostedNumberOrderResponse + title: ListMarketplaceInstalledAddOnResponse properties: - items: + installed_add_ons: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + installed_add_ons: + - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons + readEmpty: + value: + installed_add_ons: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersDependentHostedNumberOrder - x-maturity: - - Preview - /HostedNumbers/HostedNumberOrders/{Sid}: + operationId: ListMarketplaceInstalledAddOn + /marketplace/InstalledAddOns/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + installed_add_on_extension: '{installed_add_on_sid: sid}' pathType: instance + delete: + description: Remove an Add-on installation from your account + parameters: + - name: Sid + in: path + description: The SID of the InstalledAddOn resource to delete. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteMarketplaceInstalledAddOn get: - description: Fetch a specific HostedNumberOrder. + description: Fetch an instance of an Add-on currently installed on this Account. parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. + description: The SID of the InstalledAddOn resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + fetch: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchHostedNumbersHostedNumberOrder - x-maturity: - - Preview - delete: - description: Cancel the HostedNumberOrder (only available when the status is - in `received`). + operationId: FetchMarketplaceInstalledAddOn + post: + description: Update an Add-on installation for the Account specified. parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. + description: The SID of the InstalledAddOn resource to update. schema: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + update: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_2 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: DeleteHostedNumbersHostedNumberOrder - x-maturity: - - Preview + operationId: UpdateMarketplaceInstalledAddOn + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateMarketplaceInstalledAddOnRequest + properties: + Configuration: + description: Valid JSON object that conform to the configuration + schema exposed by the associated AvailableAddOn resource. This + is only required by Add-ons that need to be configured + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + examples: + update: + value: + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_2 + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension + pathType: instance + get: + description: Fetch an instance of an Extension for the Installed Add-on. + parameters: + - name: InstalledAddOnSid + in: path + description: The SID of the InstalledAddOn resource with the extension to + fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the InstalledAddOn Extension resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceInstalledAddOnExtension post: - description: Updates a specific HostedNumberOrder. + description: Update an Extension for an Add-on installation. parameters: + - name: InstalledAddOnSid + in: path + description: The SID of the InstalledAddOn resource with the extension to + update. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn Extension resource to update. schema: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + examples: + update: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: false + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateHostedNumbersHostedNumberOrder - x-maturity: - - Preview + operationId: UpdateMarketplaceInstalledAddOnExtension requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateHostedNumbersHostedNumberOrderRequest + title: UpdateMarketplaceInstalledAddOnExtensionRequest properties: - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Provides a unique and addressable name to be assigned - to this HostedNumberOrder, assigned by the developer, to be optionally - used in addition to SID. - Email: - type: string - description: Email of the owner of this phone number that is being - hosted. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that LOA document for this - HostedNumberOrder will be carbon copied to. - Status: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - description: User can only post to `pending-verification` status - to transition the HostedNumberOrder to initiate a verification - call or verification of ownership with a copy of a phone bill. - VerificationCode: - type: string - description: A verification code that is given to the user via a - phone call to the phone number that is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. - Extension: - type: string - description: Digits to dial after connecting the verification call. - CallDelay: - type: integer - description: The number of seconds, between 0 and 60, to delay before - initiating the verification call. Defaults to 0. - /HostedNumbers/HostedNumberOrders: + Enabled: + type: boolean + description: Whether the Extension should be invoked. + required: + - Enabled + examples: + update: + value: + Enabled: false + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension pathType: list get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. + description: Retrieve a list of Extensions for the Installed Add-on. parameters: - - name: Status - in: query - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. - schema: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. + - name: InstalledAddOnSid + in: path + description: The SID of the InstalledAddOn resource with the extensions to + read. schema: type: string minLength: 34 maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string + pattern: ^XE[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4014,232 +4568,286 @@ paths: application/json: schema: type: object - title: ListHostedNumbersHostedNumberOrderResponse + title: ListMarketplaceInstalledAddOnExtensionResponse properties: - items: + extensions: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: + value: + extensions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersHostedNumberOrder - x-maturity: - - Preview + operationId: ListMarketplaceInstalledAddOnExtension + /Sync/Services/{ServiceSid}/Documents/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + document_permission: '{service_sid: service_sid, document_sid: sid}' + parent: /Services/{Sid} + pathType: instance + get: + description: '' + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + description: OK + security: + - accountSid_authToken: [] + operationId: FetchSyncDocument + delete: + description: '' + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncDocument post: - description: Host a phone number's capability on Twilio's platform. + description: '' + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: Created + $ref: '#/components/schemas/preview.sync.service.document' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + description: OK security: - accountSid_authToken: [] - operationId: CreateHostedNumbersHostedNumberOrder - x-maturity: - - Preview + operationId: UpdateSyncDocument requestBody: content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersHostedNumberOrderRequest - properties: - PhoneNumber: - type: string - format: phone-number - description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) - format - SmsCapability: - type: boolean - description: Used to specify that the SMS capability will be hosted - on Twilio's platform. - AccountSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - description: This defaults to the AccountSid of the authorization - the user is using. This can be provided to specify a subaccount - to add the HostedNumberOrder to. - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Optional. Provides a unique and addressable name to - be assigned to this HostedNumberOrder, assigned by the developer, - to be optionally used in addition to SID. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that the LOA document for - this HostedNumberOrder will be carbon copied to. - SmsUrl: - type: string - format: uri - description: The URL that Twilio should request when somebody sends - an SMS to the phone number. This will be copied onto the IncomingPhoneNumber - resource. - SmsMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsUrl. Must be either `GET` or `POST`. This will be copied onto - the IncomingPhoneNumber resource. - SmsFallbackUrl: - type: string - format: uri - description: A URL that Twilio will request if an error occurs requesting - or executing the TwiML defined by SmsUrl. This will be copied - onto the IncomingPhoneNumber resource. - SmsFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied - onto the IncomingPhoneNumber resource. - StatusCallbackUrl: - type: string - format: uri - description: Optional. The Status Callback URL attached to the IncomingPhoneNumber - resource. - StatusCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: Optional. The Status Callback Method attached to the - IncomingPhoneNumber resource. - SmsApplicationSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - description: Optional. The 34 character sid of the application Twilio - should use to handle SMS messages sent to this number. If a `SmsApplicationSid` - is present, Twilio will ignore all of the SMS urls above and use - those set on the application. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: Optional. A 34 character string that uniquely identifies - the Address resource that represents the address of the owner - of this phone number. - Email: - type: string - description: Optional. Email of the owner of this phone number that - is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncDocumentRequest + properties: + Data: + description: '' required: - - PhoneNumber - - SmsCapability - /marketplace/AvailableAddOns/{Sid}: + - Data + examples: + update: + value: + Data: '{}' + UniqueName: unique_name + /Sync/Services/{ServiceSid}/Documents: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - available_add_on_extension: '{available_add_on_sid: sid}' - get: - description: Fetch an instance of an Add-on currently available to be installed. + document_permission: '{service_sid: service_sid, document_sid: sid}' + parent: /Services/{Sid} + pathType: list + post: + description: '' parameters: - - name: Sid + - name: ServiceSid in: path - description: The SID of the AvailableAddOn resource to fetch. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - description: OK + $ref: '#/components/schemas/preview.sync.service.document' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + description: Created security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOn - x-maturity: - - Preview - /marketplace/AvailableAddOns: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - available_add_on_extension: '{available_add_on_sid: sid}' + operationId: CreateSyncDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncDocumentRequest + properties: + UniqueName: + type: string + description: '' + Data: + description: '' + examples: + create: + value: + Data: '{}' + UniqueName: unique_name get: - description: Retrieve a list of Add-ons currently available to be installed. + description: '' parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4265,218 +4873,262 @@ paths: application/json: schema: type: object - title: ListMarketplaceAvailableAddOnResponse + title: ListSyncDocumentResponse properties: - available_add_ons: + documents: type: array items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' + $ref: '#/components/schemas/preview.sync.service.document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + documents: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + readFull: + value: + documents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOn - x-maturity: - - Preview - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: + operationId: ListSyncDocument + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions pathType: instance - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension get: - description: Fetch an instance of an Extension for the Available Add-on. + description: Fetch a specific Sync Document Permission. parameters: - - name: AvailableAddOnSid + - name: ServiceSid in: path - description: The SID of the AvailableAddOn resource with the extension to - fetch. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: DocumentSid in: path - description: The SID of the AvailableAddOn Extension resource to fetch. + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOnExtension - x-maturity: - - Preview - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension - get: - description: Retrieve a list of Extensions for the Available Add-on. + operationId: FetchSyncDocumentPermission + delete: + description: Delete a specific Sync Document Permission. parameters: - - name: AvailableAddOnSid + - name: ServiceSid in: path - description: The SID of the AvailableAddOn resource with the extensions to - read. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string + required: true responses: - '200': - content: - application/json: - schema: - type: object - title: ListMarketplaceAvailableAddOnExtensionResponse - properties: - extensions: - type: array - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOnExtension - x-maturity: - - Preview - /marketplace/InstalledAddOns: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - installed_add_on_extension: '{installed_add_on_sid: sid}' + operationId: DeleteSyncDocumentPermission post: - description: Install an Add-on for the Account specified. + description: Update an identity's access to a specific Sync Document. + parameters: + - name: ServiceSid + in: path + description: The unique SID identifier of the Sync Service Instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + schema: + type: string + required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: Created + $ref: '#/components/schemas/preview.sync.service.document.document_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + description: OK security: - accountSid_authToken: [] - operationId: CreateMarketplaceInstalledAddOn - x-maturity: - - Preview + operationId: UpdateSyncDocumentPermission requestBody: content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateMarketplaceInstalledAddOnRequest - properties: - AvailableAddOnSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - description: The SID of the AvaliableAddOn to install. - AcceptTermsOfService: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncDocumentPermissionRequest + properties: + Read: type: boolean - description: Whether the Terms of Service were accepted. - Configuration: - description: The JSON object that represents the configuration of - the new Add-on being installed. - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. + description: Boolean flag specifying whether the identity can read + the Sync Document. + Write: + type: boolean + description: Boolean flag specifying whether the identity can update + the Sync Document. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Document. required: - - AvailableAddOnSid - - AcceptTermsOfService + - Read + - Write + - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions + pathType: list get: - description: Retrieve a list of Add-ons currently installed on this Account. + description: Retrieve a list of all Permissions applying to a Sync Document. parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4502,244 +5154,269 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnResponse + title: ListSyncDocumentPermissionResponse properties: - installed_add_ons: + permissions: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOn - x-maturity: - - Preview - /marketplace/InstalledAddOns/{Sid}: + operationId: ListSyncDocumentPermission + /Sync/Services/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - installed_add_on_extension: '{installed_add_on_sid: sid}' - delete: - description: Remove an Add-on installation from your account + document: '{service_sid: sid}' + sync_list: '{service_sid: sid}' + sync_map: '{service_sid: sid}' + pathType: instance + get: + description: '' parameters: - name: Sid in: path - description: The SID of the InstalledAddOn resource to delete. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false + description: OK security: - accountSid_authToken: [] - operationId: DeleteMarketplaceInstalledAddOn - x-maturity: - - Preview - get: - description: Fetch an instance of an Add-on currently installed on this Account. + operationId: FetchSyncService + delete: + description: '' parameters: - name: Sid in: path - description: The SID of the InstalledAddOn resource to fetch. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOn - x-maturity: - - Preview + operationId: DeleteSyncService post: - description: Update an Add-on installation for the Account specified. + description: '' parameters: - name: Sid in: path - description: The SID of the InstalledAddOn resource to update. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.sync.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true description: OK security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOn - x-maturity: - - Preview + operationId: UpdateSyncService requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateMarketplaceInstalledAddOnRequest + title: UpdateSyncServiceRequest properties: - Configuration: - description: Valid JSON object that conform to the configuration - schema exposed by the associated AvailableAddOn resource. This - is only required by Add-ons that need to be configured - UniqueName: + WebhookUrl: type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: + format: uri + description: '' + FriendlyName: + type: string + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' + examples: + update: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + /Sync/Services: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension - get: - description: Fetch an instance of an Extension for the Installed Add-on. - parameters: - - name: InstalledAddOnSid - in: path - description: The SID of the InstalledAddOn resource with the extension to - fetch. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: The SID of the InstalledAddOn Extension resource to fetch. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOnExtension - x-maturity: - - Preview + dependentProperties: + document: '{service_sid: sid}' + sync_list: '{service_sid: sid}' + sync_map: '{service_sid: sid}' + pathType: list post: - description: Update an Extension for an Add-on installation. - parameters: - - name: InstalledAddOnSid - in: path - description: The SID of the InstalledAddOn resource with the extension to - update. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: The SID of the InstalledAddOn Extension resource to update. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ - required: true + description: '' responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK + $ref: '#/components/schemas/preview.sync.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true + description: Created security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOnExtension - x-maturity: - - Preview + operationId: CreateSyncService requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateMarketplaceInstalledAddOnExtensionRequest + title: CreateSyncServiceRequest properties: - Enabled: - type: boolean - description: Whether the Extension should be invoked. - required: - - Enabled - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension - get: - description: Retrieve a list of Extensions for the Installed Add-on. - parameters: - - name: InstalledAddOnSid - in: path - description: The SID of the InstalledAddOn resource with the extensions to - read. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ - required: true + FriendlyName: + type: string + description: '' + WebhookUrl: + type: string + format: uri + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' + examples: + create: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + get: + description: '' + parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4765,51 +5442,87 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnExtensionResponse + title: ListSyncServiceResponse properties: - extensions: + services: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.sync.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOnExtension - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Documents/{Sid}: + operationId: ListSyncService + /Sync/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - document_permission: '{service_sid: service_sid, document_sid: sid}' + sync_list_item: '{service_sid: service_sid, list_sid: sid}' + sync_list_permission: '{service_sid: service_sid, list_sid: sid}' parent: /Services/{Sid} + mountName: sync_lists + pathType: instance get: description: '' parameters: @@ -4833,13 +5546,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.sync.service.sync_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocument - x-maturity: - - Preview + operationId: FetchSyncSyncList delete: description: '' parameters: @@ -4863,65 +5589,19 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncDocument - x-maturity: - - Preview - post: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateSyncDocument - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSyncDocumentRequest - properties: - Data: - description: '' - required: - - Data - /Sync/Services/{ServiceSid}/Documents: + operationId: DeleteSyncSyncList + /Sync/Services/{ServiceSid}/Lists: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - document_permission: '{service_sid: service_sid, document_sid: sid}' + sync_list_item: '{service_sid: service_sid, list_sid: sid}' + sync_list_permission: '{service_sid: service_sid, list_sid: sid}' parent: /Services/{Sid} + mountName: sync_lists + pathType: list post: description: '' parameters: @@ -4939,25 +5619,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.sync.service.sync_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateSyncDocument - x-maturity: - - Preview + operationId: CreateSyncSyncList requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncDocumentRequest + title: CreateSyncSyncListRequest properties: UniqueName: type: string description: '' - Data: - description: '' + examples: + create: + value: + UniqueName: unique_name get: description: '' parameters: @@ -4995,52 +5690,85 @@ paths: application/json: schema: type: object - title: ListSyncDocumentResponse + title: ListSyncSyncListResponse properties: - documents: + lists: type: array items: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.sync.service.sync_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + lists: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + readFull: + value: + lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocument - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + operationId: ListSyncSyncList + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items pathType: instance - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions get: - description: Fetch a specific Sync Document Permission. + description: '' parameters: - name: ServiceSid in: path @@ -5051,33 +5779,43 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + - name: ListSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: '' schema: type: string required: true - - name: Identity + - name: Index in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: '' schema: - type: string + type: integer required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocumentPermission - x-maturity: - - Preview + operationId: FetchSyncSyncListItem delete: - description: Delete a specific Sync Document Permission. + description: '' parameters: - name: ServiceSid in: path @@ -5088,98 +5826,163 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + - name: ListSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: '' schema: type: string required: true - - name: Identity + - name: Index in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: '' schema: - type: string + type: integer required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncDocumentPermission - x-maturity: - - Preview + operationId: DeleteSyncSyncListItem post: - description: Update an identity's access to a specific Sync Document. + description: '' parameters: - name: ServiceSid in: path - description: The unique SID identifier of the Sync Service Instance. + description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + - name: ListSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: '' schema: type: string required: true - - name: Identity + - name: Index in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + description: '' schema: - type: string + type: integer required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocumentPermission - x-maturity: - - Preview + operationId: UpdateSyncSyncListItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentPermissionRequest + title: UpdateSyncSyncListItemRequest properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync Document. - Write: - type: boolean - description: Boolean flag specifying whether the identity can update - the Sync Document. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync Document. + Data: + description: '' required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + - Data + examples: + update: + value: + Data: '{}' + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items pathType: list - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + post: + description: '' + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncSyncListItem + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncSyncListItemRequest + properties: + Data: + description: '' + required: + - Data + examples: + create: + value: + Data: '{}' get: - description: Retrieve a list of all Permissions applying to a Sync Document. + description: '' parameters: - name: ServiceSid in: path @@ -5190,12 +5993,44 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + - name: ListSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: '' schema: type: string required: true + - name: Order + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc + - name: From + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: from + readFull: + value: from + - name: Bounds + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5221,56 +6056,85 @@ paths: application/json: schema: type: object - title: ListSyncDocumentPermissionResponse + title: ListSyncSyncListItemResponse properties: - permissions: + items: type: array items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocumentPermission - x-maturity: - - Preview - /Sync/Services/{Sid}: + operationId: ListSyncSyncListItem + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: instance - dependentProperties: - document: '{service_sid: sid}' - sync_list: '{service_sid: sid}' - sync_map: '{service_sid: sid}' get: - description: '' + description: Fetch a specific Sync List Permission. parameters: - - name: Sid + - name: ServiceSid in: path description: '' schema: @@ -5279,22 +6143,44 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchSyncService - x-maturity: - - Preview + operationId: FetchSyncSyncListPermission delete: - description: '' + description: Delete a specific Sync List Permission. parameters: - - name: Sid + - name: ServiceSid in: path description: '' schema: @@ -5303,106 +6189,127 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncService - x-maturity: - - Preview + operationId: DeleteSyncSyncListPermission post: - description: '' + description: Update an identity's access to a specific Sync List. parameters: - - name: Sid + - name: ServiceSid in: path - description: '' + description: The unique SID identifier of the Sync Service Instance. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + schema: + type: string + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncService - x-maturity: - - Preview + operationId: UpdateSyncSyncListPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncServiceRequest + title: UpdateSyncSyncListPermissionRequest properties: - WebhookUrl: - type: string - format: uri - description: '' - FriendlyName: - type: string - description: '' - ReachabilityWebhooksEnabled: + Read: type: boolean - description: '' - AclEnabled: + description: Boolean flag specifying whether the identity can read + the Sync List. + Write: type: boolean - description: '' - /Sync/Services: + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync List. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync List. + required: + - Read + - Write + - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: list - dependentProperties: - document: '{service_sid: sid}' - sync_list: '{service_sid: sid}' - sync_map: '{service_sid: sid}' - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncService - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncServiceRequest - properties: - FriendlyName: - type: string - description: '' - WebhookUrl: - type: string - format: uri - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync List. parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5428,53 +6335,82 @@ paths: application/json: schema: type: object - title: ListSyncServiceResponse + title: ListSyncSyncListPermissionResponse properties: - services: + permissions: type: array items: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncService - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists/{Sid}: + operationId: ListSyncSyncListPermission + /Sync/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - sync_list_item: '{service_sid: service_sid, list_sid: sid}' - sync_list_permission: '{service_sid: service_sid, list_sid: sid}' + sync_map_item: '{service_sid: service_sid, map_sid: sid}' + sync_map_permission: '{service_sid: service_sid, map_sid: sid}' parent: /Services/{Sid} - mountName: sync_lists + mountName: sync_maps + pathType: instance get: description: '' parameters: @@ -5498,13 +6434,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.sync.service.sync_map' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncList - x-maturity: - - Preview + operationId: FetchSyncSyncMap delete: description: '' parameters: @@ -5528,21 +6477,19 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncList - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists: + operationId: DeleteSyncSyncMap + /Sync/Services/{ServiceSid}/Maps: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - sync_list_item: '{service_sid: service_sid, list_sid: sid}' - sync_list_permission: '{service_sid: service_sid, list_sid: sid}' + sync_map_item: '{service_sid: service_sid, map_sid: sid}' + sync_map_permission: '{service_sid: service_sid, map_sid: sid}' parent: /Services/{Sid} - mountName: sync_lists + mountName: sync_maps + pathType: list post: description: '' parameters: @@ -5560,23 +6507,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.sync.service.sync_map' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncList - x-maturity: - - Preview + operationId: CreateSyncSyncMap requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncListRequest + title: CreateSyncSyncMapRequest properties: UniqueName: type: string description: '' + examples: + create: + value: + UniqueName: unique_name get: description: '' parameters: @@ -5614,50 +6578,83 @@ paths: application/json: schema: type: object - title: ListSyncSyncListResponse + title: ListSyncSyncMapResponse properties: - lists: + maps: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.sync.service.sync_map' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + maps: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + readFull: + value: + maps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncList - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + operationId: ListSyncSyncMap + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items pathType: instance - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items get: description: '' parameters: @@ -5670,30 +6667,41 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path description: '' schema: type: string required: true - - name: Index + - name: Key in: path description: '' schema: - type: integer + type: string required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListItem - x-maturity: - - Preview + operationId: FetchSyncSyncMapItem delete: description: '' parameters: @@ -5706,17 +6714,17 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path description: '' schema: type: string required: true - - name: Index + - name: Key in: path description: '' schema: - type: integer + type: string required: true - name: If-Match in: header @@ -5728,9 +6736,7 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncListItem - x-maturity: - - Preview + operationId: DeleteSyncSyncMapItem post: description: '' parameters: @@ -5743,17 +6749,17 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path description: '' schema: type: string required: true - - name: Index + - name: Key in: path description: '' schema: - type: integer + type: string required: true - name: If-Match in: header @@ -5765,33 +6771,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListItem - x-maturity: - - Preview + operationId: UpdateSyncSyncMapItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListItemRequest + title: UpdateSyncSyncMapItemRequest properties: Data: description: '' required: - Data - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: + examples: + update: + value: + Data: '{}' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items pathType: list - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items post: description: '' parameters: @@ -5804,7 +6825,7 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path description: '' schema: @@ -5815,24 +6836,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncListItem - x-maturity: - - Preview + operationId: CreateSyncSyncMapItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncListItemRequest + title: CreateSyncSyncMapItemRequest properties: + Key: + type: string + description: '' Data: description: '' required: + - Key - Data + examples: + create: + value: + Data: '{}' + Key: key get: description: '' parameters: @@ -5845,7 +6886,7 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path description: '' schema: @@ -5856,18 +6897,33 @@ paths: description: '' schema: type: string - $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc - name: From in: query description: '' schema: type: string + examples: + readEmpty: + value: from + readFull: + value: from - name: Bounds in: query description: '' schema: type: string - $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5893,52 +6949,83 @@ paths: application/json: schema: type: object - title: ListSyncSyncListItemResponse + title: ListSyncSyncMapItemResponse properties: items: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListItem - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + operationId: ListSyncSyncMapItem + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions pathType: instance - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions get: - description: Fetch a specific Sync List Permission. + description: Fetch a specific Sync Map Permission. parameters: - name: ServiceSid in: path @@ -5949,9 +7036,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path - description: Identifier of the Sync List. Either a SID or a unique name. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true @@ -5967,15 +7054,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListPermission - x-maturity: - - Preview + operationId: FetchSyncSyncMapPermission delete: - description: Delete a specific Sync List Permission. + description: Delete a specific Sync Map Permission. parameters: - name: ServiceSid in: path @@ -5986,9 +7082,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path - description: Identifier of the Sync List. Either a SID or a unique name. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true @@ -6004,11 +7100,9 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncListPermission - x-maturity: - - Preview + operationId: DeleteSyncSyncMapPermission post: - description: Update an identity's access to a specific Sync List. + description: Update an identity's access to a specific Sync Map. parameters: - name: ServiceSid in: path @@ -6019,9 +7113,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path - description: Identifier of the Sync List. Either a SID or a unique name. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true @@ -6037,47 +7131,62 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListPermission - x-maturity: - - Preview + operationId: UpdateSyncSyncMapPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListPermissionRequest + title: UpdateSyncSyncMapPermissionRequest properties: Read: type: boolean description: Boolean flag specifying whether the identity can read - the Sync List. + the Sync Map. Write: type: boolean description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync List. + update and delete Items of the Sync Map. Manage: type: boolean description: Boolean flag specifying whether the identity can delete - the Sync List. + the Sync Map. required: - Read - Write - Manage - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions pathType: list - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions get: - description: Retrieve a list of all Permissions applying to a Sync List. + description: Retrieve a list of all Permissions applying to a Sync Map. parameters: - name: ServiceSid in: path @@ -6088,9 +7197,9 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: MapSid in: path - description: Identifier of the Sync List. Either a SID or a unique name. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true @@ -6119,68 +7228,134 @@ paths: application/json: schema: type: object - title: ListSyncSyncListPermissionResponse + title: ListSyncSyncMapPermissionResponse properties: permissions: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListPermission - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps/{Sid}: + operationId: ListSyncSyncMapPermission + /understand/Assistants/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - sync_map_item: '{service_sid: service_sid, map_sid: sid}' - sync_map_permission: '{service_sid: service_sid, map_sid: sid}' - parent: /Services/{Sid} - mountName: sync_maps + field_type: '{assistant_sid: sid}' + task: '{assistant_sid: sid}' + model_build: '{assistant_sid: sid}' + query: '{assistant_sid: sid}' + assistant_fallback_actions: '{assistant_sid: sid}' + assistant_initiation_actions: '{assistant_sid: sid}' + dialogue: '{assistant_sid: sid}' + style_sheet: '{assistant_sid: sid}' + pathType: instance get: description: '' parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions + assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions + dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandAssistant + post: + description: '' + parameters: - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -6189,28 +7364,90 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.understand.assistant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions + assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions + dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMap - x-maturity: - - Preview + operationId: UpdateUnderstandAssistant + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUnderstandAssistantRequest + properties: + FriendlyName: + type: string + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + LogQueries: + type: boolean + 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. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + CallbackUrl: + type: string + format: uri + description: A user-provided URL to send event callbacks to. + CallbackEvents: + type: string + description: Space-separated list of callback events that will trigger + callbacks. + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + examples: + update: + value: + FriendlyName: so so friendly + UniqueName: so-so-unique + LogQueries: true + CallbackUrl: https://example.com/callback_url + CallbackEvents: model_build_completed model_build_failed + FallbackActions: '{"actions":[{}]}' + InitiationActions: '{"actions":[{}]}' + StyleSheet: '{}' delete: description: '' parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -6219,67 +7456,26 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMap - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps: + operationId: DeleteUnderstandAssistant + /understand/Assistants: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - sync_map_item: '{service_sid: service_sid, map_sid: sid}' - sync_map_permission: '{service_sid: service_sid, map_sid: sid}' - parent: /Services/{Sid} - mountName: sync_maps - post: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncSyncMap - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncSyncMapRequest - properties: - UniqueName: - type: string - description: '' + field_type: '{assistant_sid: sid}' + task: '{assistant_sid: sid}' + model_build: '{assistant_sid: sid}' + query: '{assistant_sid: sid}' + assistant_fallback_actions: '{assistant_sid: sid}' + assistant_initiation_actions: '{assistant_sid: sid}' + dialogue: '{assistant_sid: sid}' + style_sheet: '{assistant_sid: sid}' + pathType: list get: description: '' parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6305,69 +7501,181 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapResponse + title: ListUnderstandAssistantResponse properties: - maps: + assistants: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.understand.assistant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + assistants: [] + meta: + first_page_url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 + key: assistants + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 + readFull: + value: + assistants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions + assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions + dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed + meta: + first_page_url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 + key: assistants + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMap - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + operationId: ListUnderstandAssistant + post: + description: '' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-04T08:34:00Z' + date_updated: '2017-07-04T08:34:00Z' + friendly_name: so so friendly + latest_model_build_sid: null + log_queries: true + sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: so-so-unique + links: + field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes + tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds + queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries + assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions + assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions + dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues + style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + callback_url: https://example.com/callback_url + callback_events: model_build_completed model_build_failed + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandAssistant + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandAssistantRequest + properties: + FriendlyName: + type: string + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + LogQueries: + type: boolean + 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. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + CallbackUrl: + type: string + format: uri + description: A user-provided URL to send event callbacks to. + CallbackEvents: + type: string + description: Space-separated list of callback events that will trigger + callbacks. + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + examples: + create: + value: + FriendlyName: so so friendly + UniqueName: so-so-unique + LogQueries: true + CallbackUrl: https://example.com/callback_url + CallbackEvents: model_build_completed model_build_failed + FallbackActions: '{"actions":[{}]}' + InitiationActions: '{"actions":[{}]}' + StyleSheet: '{}' + /understand/Assistants/{AssistantSid}/FallbackActions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{Sid} + mountName: assistant_fallback_actions + className: assistant_fallback_actions pathType: instance - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items get: description: '' parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string - required: true - - name: Key + - name: AssistantSid in: path description: '' schema: @@ -6378,282 +7686,207 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions + data: {} description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapItem - x-maturity: - - Preview - delete: - description: '' - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string - required: true - - name: Key - in: path - description: '' - schema: - type: string - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncSyncMapItem - x-maturity: - - Preview + operationId: FetchUnderstandAssistantFallbackActions post: description: '' parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string - required: true - - name: Key + - name: AssistantSid in: path description: '' schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions + data: {} description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapItem - x-maturity: - - Preview + operationId: UpdateUnderstandAssistantFallbackActions requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapItemRequest + title: UpdateUnderstandAssistantFallbackActionsRequest properties: - Data: + FallbackActions: description: '' - required: - - Data - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + examples: + update: + value: + FallbackActions: '{"actions":[{}]}' + /understand/Assistants/{AssistantSid}/InitiationActions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items - post: + parent: /Assistants/{Sid} + mountName: assistant_initiation_actions + className: assistant_initiation_actions + pathType: instance + get: description: '' parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandAssistantInitiationActions + post: + description: '' + parameters: + - name: AssistantSid in: path description: '' schema: type: string required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: Created + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions + data: {} + description: OK security: - accountSid_authToken: [] - operationId: CreateSyncSyncMapItem - x-maturity: - - Preview + operationId: UpdateUnderstandAssistantInitiationActions requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapItemRequest + title: UpdateUnderstandAssistantInitiationActionsRequest properties: - Key: - type: string - description: '' - Data: + InitiationActions: description: '' - required: - - Key - - Data + examples: + update: + value: + InitiationActions: '{"actions":[{}]}' + /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: Sid in: path description: '' schema: type: string required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_map_item_enum_query_result_order' - - name: From - in: query - description: '' - schema: - type: string - - name: Bounds - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string responses: '200': content: application/json: schema: - type: object - title: ListSyncSyncMapItemResponse - properties: - items: - type: array - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string + $ref: '#/components/schemas/preview.understand.assistant.dialogue' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk + data: {} description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapItem - x-maturity: - - Preview - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + operationId: FetchUnderstandDialogue + /understand/Assistants/{AssistantSid}/Dialogues: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{Sid} + pathType: list + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/Tasks/{Sid} pathType: instance - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions get: - description: Fetch a specific Sync Map Permission. + description: '' parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: TaskSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: The unique ID of the Task associated with this Field. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -6662,35 +7895,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.understand.assistant.task.field' + examples: + fetch: + value: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type: field_type description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapPermission - x-maturity: - - Preview + operationId: FetchUnderstandField delete: - description: Delete a specific Sync Map Permission. + description: '' parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: TaskSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: The unique ID of the Task associated with this Field. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -6699,93 +7938,27 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapPermission - x-maturity: - - Preview - post: - description: Update an identity's access to a specific Sync Map. - parameters: - - name: ServiceSid - in: path - description: The unique SID identifier of the Sync Service Instance. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: Identifier of the Sync Map. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateSyncSyncMapPermission - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSyncSyncMapPermissionRequest - properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync Map. - Write: - type: boolean - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync Map. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync Map. - required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + operationId: DeleteUnderstandField + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/Tasks/{Sid} pathType: list - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions get: - description: Retrieve a list of all Permissions applying to a Sync Map. + description: '' parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: TaskSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: The unique ID of the Task associated with this Field. schema: type: string required: true @@ -6814,63 +7987,155 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapPermissionResponse + title: ListUnderstandFieldResponse properties: - permissions: + fields: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.understand.assistant.task.field' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + fields: [] + meta: + page: 0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + key: fields + next_page_url: null + previous_page_url: null + page_size: 50 + readFull: + value: + fields: + - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type: field_type + meta: + page: 0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 + key: fields + next_page_url: null + previous_page_url: null + page_size: 50 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapPermission - x-maturity: - - Preview - /understand/Assistants/{Sid}: + operationId: ListUnderstandField + post: + description: '' + parameters: + - name: AssistantSid + in: path + description: The unique ID of the parent Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Field. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + examples: + create: + value: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type: field_type + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandField + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandFieldRequest + properties: + FieldType: + type: string + 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. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + required: + - FieldType + - UniqueName + examples: + create: + value: + UniqueName: unique_name + FieldType: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - field_type: '{assistant_sid: sid}' - task: '{assistant_sid: sid}' - model_build: '{assistant_sid: sid}' - query: '{assistant_sid: sid}' - assistant_fallback_actions: '{assistant_sid: sid}' - assistant_initiation_actions: '{assistant_sid: sid}' - dialogue: '{assistant_sid: sid}' - style_sheet: '{assistant_sid: sid}' + field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' + parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true @@ -6879,19 +8144,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.understand.assistant.field_type' + examples: + fetch: + value: + unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandAssistant - x-maturity: - - Preview + operationId: FetchUnderstandFieldType post: description: '' parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true @@ -6900,58 +8182,57 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.understand.assistant.field_type' + examples: + update: + value: + unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistant - x-maturity: - - Preview + operationId: UpdateUnderstandFieldType requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantRequest + title: UpdateUnderstandFieldTypeRequest properties: FriendlyName: type: string - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - LogQueries: - type: boolean - 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. + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. UniqueName: type: string description: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. - CallbackUrl: - type: string - format: uri - description: A user-provided URL to send event callbacks to. - CallbackEvents: - type: string - description: Space-separated list of callback events that will trigger - callbacks. - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant + examples: + update: + value: + UniqueName: unique_name + FriendlyName: friendly_name delete: description: '' parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true @@ -6960,28 +8241,26 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteUnderstandAssistant - x-maturity: - - Preview - /understand/Assistants: + operationId: DeleteUnderstandFieldType + /understand/Assistants/{AssistantSid}/FieldTypes: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list dependentProperties: - field_type: '{assistant_sid: sid}' - task: '{assistant_sid: sid}' - model_build: '{assistant_sid: sid}' - query: '{assistant_sid: sid}' - assistant_fallback_actions: '{assistant_sid: sid}' - assistant_initiation_actions: '{assistant_sid: sid}' - dialogue: '{assistant_sid: sid}' - style_sheet: '{assistant_sid: sid}' + field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' + parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7007,104 +8286,135 @@ paths: application/json: schema: type: object - title: ListUnderstandAssistantResponse + title: ListUnderstandFieldTypeResponse properties: - assistants: + field_types: type: array items: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.understand.assistant.field_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + previous_page_url: null + page: 0 + page_size: 50 + next_page_url: null + key: field_types + field_types: [] + readFull: + value: + meta: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 + previous_page_url: null + page: 0 + page_size: 50 + next_page_url: null + key: field_types + field_types: + - unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandAssistant - x-maturity: - - Preview + operationId: ListUnderstandFieldType post: description: '' + parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.understand.assistant.field_type' + examples: + create: + value: + unique_name: unique_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + links: + field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues + sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateUnderstandAssistant - x-maturity: - - Preview + operationId: CreateUnderstandFieldType requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandAssistantRequest + title: CreateUnderstandFieldTypeRequest properties: - FriendlyName: - type: string - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - LogQueries: - type: boolean - 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. UniqueName: type: string description: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. - CallbackUrl: - type: string - format: uri - description: A user-provided URL to send event callbacks to. - CallbackEvents: + FriendlyName: type: string - description: Space-separated list of callback events that will trigger - callbacks. - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - /understand/Assistants/{AssistantSid}/FallbackActions: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + required: + - UniqueName + examples: + create: + value: + UniqueName: unique_name + FriendlyName: friendly_name + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} pathType: instance - parent: /Assistants/{Sid} - mountName: assistant_fallback_actions - className: assistant_fallback_actions get: description: '' parameters: @@ -7114,19 +8424,42 @@ paths: schema: type: string required: true + - name: FieldTypeSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + language: language + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + value: value + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + synonym_of: null description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandAssistantFallbackActions - x-maturity: - - Preview - post: + operationId: FetchUnderstandFieldValue + delete: description: '' parameters: - name: AssistantSid @@ -7135,37 +8468,32 @@ paths: schema: type: string required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateUnderstandAssistantFallbackActions - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandAssistantFallbackActionsRequest - properties: - FallbackActions: - description: '' - /understand/Assistants/{AssistantSid}/InitiationActions: + - name: FieldTypeSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteUnderstandFieldValue + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{Sid} - mountName: assistant_initiation_actions - className: assistant_initiation_actions + parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} + pathType: list get: description: '' parameters: @@ -7175,18 +8503,113 @@ paths: schema: type: string required: true + - name: FieldTypeSid + in: path + description: '' + schema: + type: string + required: true + - name: Language + in: query + description: 'An ISO language-country string of the value. For example: *en-US*' + schema: + type: string + examples: + readEmpty: + value: language + readFull: + value: language + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + type: object + title: ListUnderstandFieldValueResponse + properties: + field_values: + type: array + items: + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + field_values: [] + meta: + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + page_size: 50 + previous_page_url: null + key: field_values + page: 0 + next_page_url: null + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + readFull: + value: + field_values: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + language: language + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + value: value + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + meta: + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + page_size: 50 + previous_page_url: null + key: field_values + page: 0 + next_page_url: null + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandAssistantInitiationActions - x-maturity: - - Preview + operationId: ListUnderstandFieldValue post: description: '' parameters: @@ -7196,35 +8619,71 @@ paths: schema: type: string required: true + - name: FieldTypeSid + in: path + description: '' + schema: + type: string + required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' - description: OK + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + language: language + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + value: value + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistantInitiationActions - x-maturity: - - Preview + operationId: CreateUnderstandFieldValue requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantInitiationActionsRequest + title: CreateUnderstandFieldValueRequest properties: - InitiationActions: - description: '' - /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: + Language: + type: string + description: An ISO language-country string of the value. + Value: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + SynonymOf: + type: string + description: A value that indicates this field value is a synonym + of. Empty if the value is not a synonym. + required: + - Language + - Value + examples: + create: + value: + Value: value + Language: language + SynonymOf: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: @@ -7245,47 +8704,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.dialogue' + $ref: '#/components/schemas/preview.understand.assistant.model_build' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: enqueued + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: null + error_code: null description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandDialogue - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Dialogues: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Assistants/{Sid} - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: + operationId: FetchUnderstandModelBuild + post: description: '' parameters: - name: AssistantSid in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. + description: '' schema: type: string required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true @@ -7294,31 +8742,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.understand.assistant.model_build' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: 100 + error_code: null description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandField - x-maturity: - - Preview + operationId: UpdateUnderstandModelBuild + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUnderstandModelBuildRequest + properties: + UniqueName: + type: string + 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' + examples: + update: + value: + UniqueName: unique_name delete: description: '' parameters: - name: AssistantSid in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. + description: '' schema: type: string required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true @@ -7327,29 +8796,21 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteUnderstandField - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: + operationId: DeleteUnderstandModelBuild + /understand/Assistants/{AssistantSid}/ModelBuilds: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{Sid} pathType: list - parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' parameters: - name: AssistantSid in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. + description: '' schema: type: string required: true @@ -7378,53 +8839,78 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldResponse + title: ListUnderstandModelBuildResponse properties: - fields: + model_builds: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.understand.assistant.model_build' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + page: 0 + key: model_builds + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + page_size: 50 + model_builds: [] + readFull: + value: + meta: + page: 0 + key: model_builds + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + next_page_url: null + previous_page_url: null + page_size: 50 + model_builds: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: failed + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: null + error_code: 23001 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandField - x-maturity: - - Preview + operationId: ListUnderstandModelBuild post: description: '' parameters: - name: AssistantSid in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. + description: '' schema: type: string required: true @@ -7433,55 +8919,65 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.understand.assistant.model_build' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: enqueued + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + build_duration: null + error_code: null description: Created security: - accountSid_authToken: [] - operationId: CreateUnderstandField - x-maturity: - - Preview + operationId: CreateUnderstandModelBuild requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandFieldRequest + title: CreateUnderstandModelBuildRequest properties: - FieldType: + StatusCallback: type: string - 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. + format: uri + description: '' UniqueName: type: string - description: A user-provided string that uniquely identifies this + description: 'A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters - long. - required: - - FieldType - - UniqueName - /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: + long. For example: v0.1' + examples: + create: + value: + UniqueName: unique_name + StatusCallback: http://www.example.com + /understand/Assistants/{AssistantSid}/Queries/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance - dependentProperties: - field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -7490,25 +8986,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.understand.assistant.query' + examples: + fetch: + value: + language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: + name: name + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: 0.9 + entities: + - name: name + value: value + type: type + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: voice description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandFieldType - x-maturity: - - Preview + operationId: FetchUnderstandQuery post: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the parent Assistant. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -7517,41 +9035,70 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.understand.assistant.query' + examples: + update: + value: + language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: + name: name + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: 0.9 + entities: + - name: name + value: value + type: type + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: sms description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandFieldType - x-maturity: - - Preview + operationId: UpdateUnderstandQuery requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandFieldTypeRequest + title: UpdateUnderstandQueryRequest properties: - FriendlyName: + SampleSid: type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - UniqueName: + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + description: An optional reference to the Sample created from this + query. + Status: type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. + description: 'A string that described the query status. The values + can be: pending_review, reviewed, discarded' + examples: + update: + value: + Status: status + SampleSid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -7560,28 +9107,55 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteUnderstandFieldType - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/FieldTypes: + operationId: DeleteUnderstandQuery + /understand/Assistants/{AssistantSid}/Queries: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list - dependentProperties: - field_value: '{assistant_sid: assistant_sid, field_type_sid: sid}' parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the parent Assistant. schema: type: string required: true + - name: Language + in: query + description: An ISO language-country string of the sample. + schema: + type: string + examples: + readEmpty: + value: language + readFull: + value: language + - name: ModelBuild + in: query + description: The Model Build Sid or unique name of the Model Build to be queried. + schema: + type: string + examples: + readEmpty: + value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: Status + in: query + description: 'A string that described the query status. The values can be: + pending_review, reviewed, discarded' + schema: + type: string + examples: + readEmpty: + value: status + readFull: + value: status - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7607,47 +9181,89 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldTypeResponse + title: ListUnderstandQueryResponse properties: - field_types: + queries: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.understand.assistant.query' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + queries: [] + meta: + previous_page_url: null + next_page_url: null + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page: 0 + key: queries + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page_size: 50 + readFull: + value: + queries: + - language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: + name: name + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: 0.9 + entities: + - name: name + value: value + type: type + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: null + meta: + previous_page_url: null + next_page_url: null + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page: 0 + key: queries + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 + page_size: 50 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandFieldType - x-maturity: - - Preview + operationId: ListUnderstandQuery post: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the parent Assistant. schema: type: string required: true @@ -7656,129 +9272,264 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.understand.assistant.query' + examples: + create: + value: + language: language + date_created: '2015-07-30T20:00:00Z' + model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + query: query + date_updated: '2015-07-30T20:00:00Z' + status: status + sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + task: + name: name + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + confidence: 0.9 + entities: + - name: name + value: value + type: type + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_channel: voice description: Created security: - accountSid_authToken: [] - operationId: CreateUnderstandFieldType - x-maturity: - - Preview + operationId: CreateUnderstandQuery requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandFieldTypeRequest + title: CreateUnderstandQueryRequest properties: - UniqueName: + Language: + type: string + description: An ISO language-country string of the sample. + Query: type: string description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters + resource as an alternative to the sid. It can be up to 2048 characters long. - FriendlyName: + Tasks: type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. + 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* + ModelBuild: + type: string + description: The Model Build Sid or unique name of the Model Build + to be queried. + Field: + type: string + 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* required: - - UniqueName - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: + - Language + - Query + examples: + create: + value: + Language: language + Query: query + Tasks: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + Field: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ModelBuild: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/Tasks/{Sid} pathType: instance - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - - name: FieldTypeSid + - name: TaskSid in: path - description: '' + description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + examples: + fetch: + value: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: null description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandFieldValue - x-maturity: - - Preview + operationId: FetchUnderstandSample + post: + description: '' + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Sample. + schema: + type: string + required: true + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + examples: + update: + value: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: alexa + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateUnderstandSample + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUnderstandSampleRequest + properties: + Language: + type: string + description: An ISO language-country string of the sample. + TaggedText: + type: string + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + SourceChannel: + type: string + 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' + examples: + update: + value: + Language: language + TaggedText: tagged_text delete: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - - name: FieldTypeSid + - name: TaskSid in: path - description: '' + description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteUnderstandFieldValue - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: + operationId: DeleteUnderstandSample + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/Tasks/{Sid} pathType: list - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - - name: FieldTypeSid + - name: TaskSid in: path - description: '' + description: The unique ID of the Task associated with this Sample. schema: type: string required: true - name: Language in: query - description: 'An ISO language-country string of the value. For example: *en-US*' + description: An ISO language-country string of the sample. schema: type: string + examples: + readEmpty: + value: language + readFull: + value: language - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7804,110 +9555,237 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldValueResponse + title: ListUnderstandSampleResponse properties: - field_values: + samples: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.understand.assistant.task.sample' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + samples: [] + meta: + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + previous_page_url: null + key: samples + next_page_url: null + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + page: 0 + page_size: 50 + readFull: + value: + samples: + - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: sms + meta: + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + previous_page_url: null + key: samples + next_page_url: null + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 + page: 0 + page_size: 50 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandFieldValue - x-maturity: - - Preview + operationId: ListUnderstandSample post: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Sample. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + examples: + create: + value: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + language: language + tagged_text: tagged_text + date_updated: '2015-07-30T20:00:00Z' + source_channel: alexa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandSample + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandSampleRequest + properties: + Language: + type: string + description: An ISO language-country string of the sample. + TaggedText: + type: string + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + SourceChannel: + type: string + 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' + required: + - Language + - TaggedText + examples: + create: + value: + Language: language + TaggedText: tagged_text + SourceChannel: alexa + /understand/Assistants/{AssistantSid}/StyleSheet: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Assistants/{Sid} + pathType: instance + get: + description: Returns Style sheet JSON object for this Assistant + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant schema: type: string required: true - - name: FieldTypeSid + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandStyleSheet + post: + description: Updates the style sheet for an assistant identified by {AssistantSid} + or {AssistantUniqueName}. + parameters: + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant schema: type: string required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' - description: Created + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + data: {} + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandFieldValue - x-maturity: - - Preview + operationId: UpdateUnderstandStyleSheet requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandFieldValueRequest + title: UpdateUnderstandStyleSheetRequest properties: - Language: - type: string - description: An ISO language-country string of the value. - Value: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - SynonymOf: - type: string - description: A value that indicates this field value is a synonym - of. Empty if the value is not a synonym. - required: - - Language - - Value - /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: + StyleSheet: + description: The JSON Style sheet string + examples: + update: + value: + StyleSheet: '{}' + /understand/Assistants/{AssistantSid}/Tasks/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance + dependentProperties: + field: '{assistant_sid: assistant_sid, task_sid: sid}' + sample: '{assistant_sid: assistant_sid, task_sid: sid}' + task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' + task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' parent: /Assistants/{Sid} + pathType: instance get: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -7916,25 +9794,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.understand.assistant.task' + examples: + fetch: + value: + unique_name: unique_name + links: + fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandModelBuild - x-maturity: - - Preview + operationId: FetchUnderstandTask post: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -7943,37 +9836,71 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.understand.assistant.task' + examples: + update: + value: + unique_name: unique_name + links: + fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandModelBuild - x-maturity: - - Preview + operationId: UpdateUnderstandTask requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandModelBuildRequest + title: UpdateUnderstandTaskRequest properties: + FriendlyName: + type: string + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. UniqueName: type: string - description: 'A user-provided string that uniquely identifies this + 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' + long. + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + ActionsUrl: + type: string + format: uri + description: User-provided HTTP endpoint where from the assistant + fetches actions + examples: + update: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Actions: '{"say":{"speech":"Your order is ready for pickup"}}' + ActionsUrl: https://example.com/actions_url delete: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -7982,23 +9909,26 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteUnderstandModelBuild - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/ModelBuilds: + operationId: DeleteUnderstandTask + /understand/Assistants/{AssistantSid}/Tasks: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list + dependentProperties: + field: '{assistant_sid: assistant_sid, task_sid: sid}' + sample: '{assistant_sid: assistant_sid, task_sid: sid}' + task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' + task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' parent: /Assistants/{Sid} + pathType: list get: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true @@ -8027,47 +9957,82 @@ paths: application/json: schema: type: object - title: ListUnderstandModelBuildResponse + title: ListUnderstandTaskResponse properties: - model_builds: + tasks: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.understand.assistant.task' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + key: tasks + page_size: 50 + next_page_url: null + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + page: 0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + previous_page_url: null + tasks: [] + readFull: + value: + meta: + key: tasks + page_size: 50 + next_page_url: null + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + page: 0 + first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + previous_page_url: null + tasks: + - unique_name: unique_name + links: + fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandModelBuild - x-maturity: - - Preview + operationId: ListUnderstandTask post: description: '' parameters: - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true @@ -8076,49 +10041,83 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.understand.assistant.task' + examples: + create: + value: + unique_name: unique_name + links: + fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields + samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples + task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions + statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + actions_url: https://example.com/actions_url description: Created security: - accountSid_authToken: [] - operationId: CreateUnderstandModelBuild - x-maturity: - - Preview + operationId: CreateUnderstandTask requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandModelBuildRequest + title: CreateUnderstandTaskRequest properties: - StatusCallback: - type: string - format: uri - description: '' UniqueName: type: string - description: 'A user-provided string that uniquely identifies this + 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' - /understand/Assistants/{AssistantSid}/Queries/{Sid}: + long. + FriendlyName: + type: string + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + ActionsUrl: + type: string + format: uri + description: User-provided HTTP endpoint where from the assistant + fetches actions + required: + - UniqueName + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Actions: '{"say":{"speech":"Your order is ready for pickup"}}' + ActionsUrl: https://example.com/actions_url + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + mountName: task_actions + className: task_actions pathType: instance - parent: /Assistants/{Sid} get: - description: '' + description: Returns JSON actions for this Task. parameters: - name: AssistantSid in: path - description: The unique ID of the Assistant. + description: The unique ID of the parent Assistant. schema: type: string required: true - - name: Sid + - name: TaskSid in: path - description: A 34 character string that uniquely identifies this resource. + description: The unique ID of the Task. schema: type: string required: true @@ -8127,15 +10126,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDdddddddddddddddddddddddddddddddd + data: {} + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandQuery - x-maturity: - - Preview + operationId: FetchUnderstandTaskActions post: - description: '' + description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. parameters: - name: AssistantSid in: path @@ -8143,9 +10148,9 @@ paths: schema: type: string required: true - - name: Sid + - name: TaskSid in: path - description: A 34 character string that uniquely identifies this resource. + description: The unique ID of the Task. schema: type: string required: true @@ -8154,87 +10159,169 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDdddddddddddddddddddddddddddddddd + data: {} + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandQuery - x-maturity: - - Preview + operationId: UpdateUnderstandTaskActions requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandQueryRequest + title: UpdateUnderstandTaskActionsRequest properties: - SampleSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - description: An optional reference to the Sample created from this - query. - Status: - type: string - description: 'A string that described the query status. The values - can be: pending_review, reviewed, discarded' - delete: + Actions: + description: The JSON actions that instruct the Assistant how to + perform this task. + examples: + update: + value: + Actions: '{"actions":[{}]}' + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + className: task_statistics + pathType: instance + get: description: '' parameters: - name: AssistantSid in: path - description: The unique ID of the Assistant. + description: The unique ID of the parent Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Field. schema: type: string required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' + examples: + fetch: + value: + url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + samples_count: 0 + fields_count: 0 + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandTaskStatistics + /wireless/Commands/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + get: + description: '' + parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.command' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: DeleteUnderstandQuery - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Queries: + operationId: FetchWirelessCommand + /wireless/Commands: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Assistants/{Sid} get: description: '' parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. + - name: Device + in: query + description: '' schema: type: string - required: true - - name: Language + examples: + readEmpty: + value: device + readFull: + value: device + - name: Sim in: query - description: An ISO language-country string of the sample. + description: '' schema: type: string - - name: ModelBuild + examples: + readEmpty: + value: sim + readFull: + value: sim + - name: Status in: query - description: The Model Build Sid or unique name of the Model Build to be queried. + description: '' schema: type: string - - name: Status + examples: + readEmpty: + value: status + readFull: + value: status + - name: Direction in: query - description: 'A string that described the query status. The values can be: - pending_review, reviewed, discarded' + description: '' schema: type: string + examples: + readEmpty: + value: direction + readFull: + value: direction - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8260,253 +10347,150 @@ paths: application/json: schema: type: object - title: ListUnderstandQueryResponse + title: ListWirelessCommandResponse properties: - queries: + commands: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.wireless.command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + commands: [] + meta: + first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + readFull: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Commands?Device=device&Status=status&Direction=direction&Sim=sim&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandQuery - x-maturity: - - Preview + operationId: ListWirelessCommand post: description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.wireless.command' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: command_mode + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + device_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: direction + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: status + url: https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateUnderstandQuery - x-maturity: - - Preview + operationId: CreateWirelessCommand requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandQueryRequest + title: CreateWirelessCommandRequest properties: - Language: - type: string - description: An ISO language-country string of the sample. - Query: + Command: type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. It can be up to 2048 characters - long. - Tasks: + description: '' + Device: type: string - 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* - ModelBuild: + description: '' + Sim: type: string - description: The Model Build Sid or unique name of the Model Build - to be queried. - Field: + description: '' + CallbackMethod: type: string - 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* - required: - - Language - - Query - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandSample - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateUnderstandSample - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandSampleRequest - properties: - Language: + description: '' + CallbackUrl: type: string - description: An ISO language-country string of the sample. - TaggedText: + format: uri + description: '' + CommandMode: type: string - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - SourceChannel: + description: '' + IncludeSid: type: string - 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' - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandSample - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: + description: '' + required: + - Command + examples: + create: + value: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: command_mode + Device: device + Sim: sim + IncludeSid: include_sid + /wireless/RatePlans: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string - required: true - - name: Language - in: query - description: An ISO language-country string of the sample. - schema: - type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8532,104 +10516,299 @@ paths: application/json: schema: type: object - title: ListUnderstandSampleResponse + title: ListWirelessRatePlanResponse properties: - samples: + rate_plans: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' + $ref: '#/components/schemas/preview.wireless.rate_plan' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + rate_plans: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/RatePlans?PageSize=50&Page=0 + rate_plans: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandSample - x-maturity: - - Preview + operationId: ListWirelessRatePlan post: + description: '' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateWirelessRatePlan + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateWirelessRatePlanRequest + properties: + UniqueName: + type: string + description: '' + FriendlyName: + type: string + description: '' + DataEnabled: + type: boolean + description: '' + DataLimit: + type: integer + description: '' + DataMetering: + type: string + description: '' + MessagingEnabled: + type: boolean + description: '' + VoiceEnabled: + type: boolean + description: '' + CommandsEnabled: + type: boolean + description: '' + NationalRoamingEnabled: + type: boolean + description: '' + InternationalRoaming: + type: array + items: + type: string + description: '' + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 1000 + DataMetering: pooled + MessagingEnabled: true + VoiceEnabled: true + FriendlyName: friendly_name + NationalRoamingEnabled: true + InternationalRoaming: + - data + - voice + - messaging + Status: status + /wireless/RatePlans/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + pathType: instance + get: description: '' parameters: - - name: AssistantSid + - name: Sid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string required: true - - name: TaskSid + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWirelessRatePlan + post: + description: '' + parameters: + - name: Sid in: path - description: The unique ID of the Task associated with this Sample. + description: '' schema: type: string required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - description: Created + $ref: '#/components/schemas/preview.wireless.rate_plan' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: pooled + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + international_roaming: + - data + - messaging + - voice + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandSample - x-maturity: - - Preview + operationId: UpdateWirelessRatePlan requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandSampleRequest + title: UpdateWirelessRatePlanRequest properties: - Language: - type: string - description: An ISO language-country string of the sample. - TaggedText: + UniqueName: type: string - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - SourceChannel: + description: '' + FriendlyName: type: string - 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' - required: - - Language - - TaggedText - /understand/Assistants/{AssistantSid}/StyleSheet: + description: '' + examples: + update: + value: + UniqueName: unique_name + FriendlyName: friendly_name + delete: + description: '' + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteWirelessRatePlan + /wireless/Sims/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + usage: '{sim_sid: sid}' pathType: instance - parent: /Assistants/{Sid} get: - description: Returns Style sheet JSON object for this Assistant + description: '' parameters: - - name: AssistantSid + - name: Sid in: path - description: The unique ID of the Assistant + description: '' schema: type: string required: true @@ -8638,20 +10817,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + $ref: '#/components/schemas/preview.wireless.sim' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandStyleSheet - x-maturity: - - Preview + operationId: FetchWirelessSim post: - description: Updates the style sheet for an assistant identified by {AssistantSid} - or {AssistantUniqueName}. + description: '' parameters: - - name: AssistantSid + - name: Sid in: path - description: The unique ID of the Assistant + description: '' schema: type: string required: true @@ -8660,158 +10863,210 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + $ref: '#/components/schemas/preview.wireless.sim' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandStyleSheet - x-maturity: - - Preview + operationId: UpdateWirelessSim requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandStyleSheetRequest + title: UpdateWirelessSimRequest properties: - StyleSheet: - description: The JSON Style sheet string - /understand/Assistants/{AssistantSid}/Tasks/{Sid}: + UniqueName: + type: string + description: '' + CallbackMethod: + type: string + description: '' + CallbackUrl: + type: string + format: uri + description: '' + FriendlyName: + type: string + description: '' + RatePlan: + type: string + description: '' + Status: + type: string + description: '' + CommandsCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + CommandsCallbackUrl: + type: string + format: uri + description: '' + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + SmsFallbackUrl: + type: string + format: uri + description: '' + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + SmsUrl: + type: string + format: uri + description: '' + VoiceFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + VoiceFallbackUrl: + type: string + format: uri + description: '' + VoiceMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: '' + VoiceUrl: + type: string + format: uri + description: '' + examples: + update: + value: + UniqueName: unique_name + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + CommandsCallbackMethod: http_method + CommandsCallbackUrl: http://www.example.com + VoiceMethod: http_method + VoiceUrl: http://www.example.com + VoiceFallbackMethod: http_method + VoiceFallbackUrl: http://www.example.com + SmsMethod: http_method + SmsUrl: http://www.example.com + SmsFallbackMethod: http_method + SmsFallbackUrl: http://www.example.com + FriendlyName: friendly_name + RatePlan: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Status: status + /wireless/Sims: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance dependentProperties: - field: '{assistant_sid: assistant_sid, task_sid: sid}' - sample: '{assistant_sid: assistant_sid, task_sid: sid}' - task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' - task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' - parent: /Assistants/{Sid} + usage: '{sim_sid: sid}' + pathType: list get: description: '' parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandTask - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. + - name: Status + in: query + description: '' schema: type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. + examples: + readEmpty: + value: status + readFull: + value: status + - name: Iccid + in: query + description: '' schema: type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateUnderstandTask - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandTaskRequest - properties: - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - ActionsUrl: - type: string - format: uri - description: User-provided HTTP endpoint where from the assistant - fetches actions - delete: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. + examples: + readEmpty: + value: iccid + readFull: + value: iccid + - name: RatePlan + in: query + description: '' schema: type: string - required: true - - name: Sid - in: path - description: A 34 character string that uniquely identifies this resource. + examples: + readEmpty: + value: rate_plan + readFull: + value: rate_plan + - name: EId + in: query + description: '' schema: type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandTask - x-maturity: - - Preview - /understand/Assistants/{AssistantSid}/Tasks: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - field: '{assistant_sid: assistant_sid, task_sid: sid}' - sample: '{assistant_sid: assistant_sid, task_sid: sid}' - task_actions: '{assistant_sid: assistant_sid, task_sid: sid}' - task_statistics: '{assistant_sid: assistant_sid, task_sid: sid}' - parent: /Assistants/{Sid} - get: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. + - name: SimRegistrationCode + in: query + description: '' schema: type: string - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8837,207 +11092,189 @@ paths: application/json: schema: type: object - title: ListUnderstandTaskResponse + title: ListWirelessSimResponse properties: - tasks: + sims: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task' + $ref: '#/components/schemas/preview.wireless.sim' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sims: [] + meta: + first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + readFull: + value: + sims: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: http_method + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + usage: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + rate_plan: https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: status + sms_fallback_method: http_method + sms_fallback_url: http://www.example.com + sms_method: http_method + sms_url: http://www.example.com + voice_fallback_method: http_method + voice_fallback_url: http://www.example.com + voice_method: http_method + voice_url: http://www.example.com + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandTask - x-maturity: - - Preview - post: - description: '' - parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandTask - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandTaskRequest - properties: - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - ActionsUrl: - type: string - format: uri - description: User-provided HTTP endpoint where from the assistant - fetches actions - required: - - UniqueName - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: + operationId: ListWirelessSim + /wireless/Sims/{SimSid}/Usage: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /Sims/{Sid} pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - mountName: task_actions - className: task_actions get: - description: Returns JSON actions for this Task. + description: '' parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - - name: TaskSid + - name: SimSid in: path - description: The unique ID of the Task. + description: '' schema: type: string required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandTaskActions - x-maturity: - - Preview - post: - description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. - parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. + - name: End + in: query + description: '' schema: type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task. + examples: + fetch: + value: end + - name: Start + in: query + description: '' schema: type: string - required: true + examples: + fetch: + value: start responses: '200': content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateUnderstandTaskActions - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandTaskActionsRequest - properties: - Actions: - description: The JSON actions that instruct the Assistant how to - perform this task. - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: + application/json: + schema: + $ref: '#/components/schemas/preview.wireless.sim.usage' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands_costs: {} + commands_usage: {} + data_costs: {} + data_usage: {} + sim_unique_name: sim_unique_name + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: {} + url: https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWirelessUsage + /HostedNumbers/AuthorizationDocuments/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_order: '{signing_document_sid: sid}' pathType: instance - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - className: task_statistics get: - description: '' + description: Fetch a specific AuthorizationDocument. parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - - name: TaskSid + - name: Sid in: path - description: The unique ID of the Task associated with this Field. + description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + fetch: + value: + address_sid: AD11111111111111111111111111111111 + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandTaskStatistics - x-maturity: - - Preview - /wireless/Commands/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - get: - description: '' + operationId: FetchHostedNumbersAuthorizationDocument + post: + description: Updates a specific AuthorizationDocument. parameters: - name: Sid in: path @@ -9046,50 +11283,126 @@ paths: type: string minLength: 34 maxLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.command' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + update: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchWirelessCommand - x-maturity: - - Preview - /wireless/Commands: + operationId: UpdateHostedNumbersAuthorizationDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateHostedNumbersAuthorizationDocumentRequest + properties: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + Status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + description: 'Status of an instance resource. It can hold one of + the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, + 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. + examples: + update: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + Status: signing + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_order: '{signing_document_sid: sid}' pathType: list get: - description: '' + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. parameters: - - name: Device - in: query - description: '' - schema: - type: string - - name: Sim + - name: Email in: query - description: '' + description: Email that this AuthorizationDocument will be sent to for signing. schema: type: string + examples: + readEmpty: + value: test+hosted@twilio.com - name: Status in: query - description: '' - schema: - type: string - - name: Direction - in: query - description: '' + 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.' schema: type: string + $ref: '#/components/schemas/authorization_document_enum_status' + examples: + readEmpty: + value: signed - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9115,96 +11428,232 @@ paths: application/json: schema: type: object - title: ListWirelessCommandResponse + title: ListHostedNumbersAuthorizationDocumentResponse properties: - commands: + items: type: array items: - $ref: '#/components/schemas/preview.wireless.command' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + items: + - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListWirelessCommand - x-maturity: - - Preview + operationId: ListHostedNumbersAuthorizationDocument post: - description: '' + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.command' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + examples: + create: + value: + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + links: + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateWirelessCommand - x-maturity: - - Preview + operationId: CreateHostedNumbersAuthorizationDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateWirelessCommandRequest + title: CreateHostedNumbersAuthorizationDocumentRequest properties: - Command: - type: string - description: '' - Device: - type: string - description: '' - Sim: - type: string - description: '' - CallbackMethod: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: type: string - description: '' - CallbackUrl: + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: type: string - format: uri - description: '' - CommandMode: + description: Email that this AuthorizationDocument will be sent + to for signing. + ContactTitle: type: string - description: '' - IncludeSid: + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: type: string - description: '' + description: The contact phone number of the person authorized to + sign the Authorization Document. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. required: - - Command - /wireless/RatePlans: + - HostedNumberOrderSids + - AddressSid + - Email + - ContactTitle + - ContactPhoneNumber + examples: + create: + value: + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] + parent: /AuthorizationDocuments/{Sid} pathType: list get: - description: '' + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. parameters: + - name: SigningDocumentSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + examples: + readEmpty: + value: example + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9230,362 +11679,354 @@ paths: application/json: schema: type: object - title: ListWirelessRatePlanResponse + title: ListHostedNumbersDependentHostedNumberOrderResponse properties: - rate_plans: + items: type: array items: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + failure_reason: '' + unique_name: foobar + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: ListWirelessRatePlan - x-maturity: - - Preview - post: - description: '' - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateWirelessRatePlan - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateWirelessRatePlanRequest - properties: - UniqueName: - type: string - description: '' - FriendlyName: - type: string - description: '' - DataEnabled: - type: boolean - description: '' - DataLimit: - type: integer - description: '' - DataMetering: - type: string - description: '' - MessagingEnabled: - type: boolean - description: '' - VoiceEnabled: - type: boolean - description: '' - CommandsEnabled: - type: boolean - description: '' - NationalRoamingEnabled: - type: boolean - description: '' - InternationalRoaming: - type: array - items: - type: string - description: '' - /wireless/RatePlans/{Sid}: + operationId: ListHostedNumbersDependentHostedNumberOrder + /HostedNumbers/HostedNumberOrders/{Sid}: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: instance get: - description: '' - parameters: - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchWirelessRatePlan - x-maturity: - - Preview - post: - description: '' + description: Fetch a specific HostedNumberOrder. parameters: - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.rate_plan' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '5105' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: UpdateWirelessRatePlan - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateWirelessRatePlanRequest - properties: - UniqueName: - type: string - description: '' - FriendlyName: - type: string - description: '' + operationId: FetchHostedNumbersHostedNumberOrder delete: - description: '' + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). parameters: - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteWirelessRatePlan - x-maturity: - - Preview - /wireless/Sims/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - usage: '{sim_sid: sid}' - get: - description: '' - parameters: - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.wireless.sim' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchWirelessSim - x-maturity: - - Preview + operationId: DeleteHostedNumbersHostedNumberOrder post: - description: '' + description: Updates a specific HostedNumberOrder. parameters: - name: Sid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: new friendly name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: pending-loa + unique_name: new unique name + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 1 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: UpdateWirelessSim - x-maturity: - - Preview + operationId: UpdateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateWirelessSimRequest + title: UpdateHostedNumbersHostedNumberOrderRequest properties: - UniqueName: - type: string - description: '' - CallbackMethod: - type: string - description: '' - CallbackUrl: - type: string - format: uri - description: '' FriendlyName: type: string - description: '' - RatePlan: - type: string - description: '' - Status: - type: string - description: '' - CommandsCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - CommandsCallbackUrl: - type: string - format: uri - description: '' - SmsFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - SmsFallbackUrl: + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: type: string - format: uri - description: '' - SmsMethod: + description: Provides a unique and addressable name to be assigned + to this HostedNumberOrder, assigned by the developer, to be optionally + used in addition to SID. + Email: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - SmsUrl: + description: Email of the owner of this phone number that is being + hosted. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that LOA document for this + HostedNumberOrder will be carbon copied to. + Status: type: string - format: uri - description: '' - VoiceFallbackMethod: + $ref: '#/components/schemas/hosted_number_order_enum_status' + description: User can only post to `pending-verification` status + to transition the HostedNumberOrder to initiate a verification + call or verification of ownership with a copy of a phone bill. + VerificationCode: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - VoiceFallbackUrl: + description: A verification code that is given to the user via a + phone call to the phone number that is being hosted. + VerificationType: type: string - format: uri - description: '' - VoiceMethod: + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: '' - VoiceUrl: + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + Extension: type: string - format: uri - description: '' - /wireless/Sims: + description: Digits to dial after connecting the verification call. + CallDelay: + type: integer + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. + examples: + update: + value: + FriendlyName: new friendly name + UniqueName: new unique name + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + Status: pending-loa + Extension: '1234' + CallDelay: 15 + /HostedNumbers/HostedNumberOrders: servers: - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] pathType: list - dependentProperties: - usage: '{sim_sid: sid}' get: - description: '' + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. parameters: - name: Status in: query - description: '' + description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. schema: type: string - - name: Iccid + $ref: '#/components/schemas/hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber in: query - description: '' + description: An E164 formatted phone number hosted by this HostedNumberOrder. schema: type: string - - name: RatePlan + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid in: query - description: '' + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. schema: type: string - - name: EId + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz + - name: FriendlyName in: query - description: '' + description: A human readable description of this resource, up to 64 characters. schema: type: string - - name: SimRegistrationCode + examples: + readEmpty: + value: example + - name: UniqueName in: query - description: '' + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. schema: type: string + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9611,84 +12052,333 @@ paths: application/json: schema: type: object - title: ListWirelessSimResponse + title: ListHostedNumbersHostedNumberOrderResponse properties: - sims: + items: type: array items: - $ref: '#/components/schemas/preview.wireless.sim' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + items: [] + readFull: + value: + meta: + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: ListWirelessSim - x-maturity: - - Preview - /wireless/Sims/{SimSid}/Usage: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Sims/{Sid} - get: - description: '' - parameters: - - name: SimSid - in: path - description: '' - schema: - type: string - required: true - - name: End - in: query - description: '' - schema: - type: string - - name: Start - in: query - description: '' - schema: - type: string + operationId: ListHostedNumbersHostedNumberOrder + post: + description: Host a phone number's capability on Twilio's platform. responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.wireless.sim.usage' - description: OK + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithoutOptionalLoaFields: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithPhoneBillVerification: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_type: phone-bill + description: Created security: - accountSid_authToken: [] - operationId: FetchWirelessUsage - x-maturity: - - Preview + operationId: CreateHostedNumbersHostedNumberOrder + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateHostedNumbersHostedNumberOrderRequest + properties: + PhoneNumber: + type: string + format: phone-number + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + SmsCapability: + type: boolean + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + AccountSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + description: This defaults to the AccountSid of the authorization + the user is using. This can be provided to specify a subaccount + to add the HostedNumberOrder to. + FriendlyName: + type: string + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: + type: string + description: Optional. Provides a unique and addressable name to + be assigned to this HostedNumberOrder, assigned by the developer, + to be optionally used in addition to SID. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + SmsUrl: + type: string + format: uri + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsUrl. Must be either `GET` or `POST`. This will be copied onto + the IncomingPhoneNumber resource. + SmsFallbackUrl: + type: string + format: uri + description: A URL that Twilio will request if an error occurs requesting + or executing the TwiML defined by SmsUrl. This will be copied + onto the IncomingPhoneNumber resource. + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied + onto the IncomingPhoneNumber resource. + StatusCallbackUrl: + type: string + format: uri + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + StatusCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + SmsApplicationSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AP[0-9a-fA-F]{32}$ + description: Optional. The 34 character sid of the application Twilio + should use to handle SMS messages sent to this number. If a `SmsApplicationSid` + is present, Twilio will ignore all of the SMS urls above and use + those set on the application. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + Email: + type: string + description: Optional. Email of the owner of this phone number that + is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + required: + - PhoneNumber + - SmsCapability + examples: + create: + value: + AddressSid: AD11111111111111111111111111111111 + PhoneNumber: '+14153608311' + SmsCapability: true + Email: test@twilio.com + createWithoutOptionalLoaFields: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + createWithPhoneBillVerification: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + VerificationType: phone-bill + VerificationDocumentSid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa servers: - url: https://preview.twilio.com -x-maturity: -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index c5c0cb81..4212754d 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: pricing.v1.messaging: type: object @@ -312,10 +316,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Pricing description: This is the public Twilio REST API. @@ -327,13 +327,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Messaging: servers: - url: https://pricing.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - name @@ -348,8 +348,8 @@ paths: - outbound_sms_prices - inbound_sms_prices - price_unit - pathType: list parent: /Messaging + pathType: list get: description: '' parameters: @@ -385,34 +385,58 @@ paths: items: $ref: '#/components/schemas/pricing.v1.messaging.messaging_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 + readFull: + value: + countries: + - country: country + iso_country: US + url: https://pricing.twilio.com/v1/Messaging/Countries/US + meta: + first_page_url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Messaging/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListMessagingCountry - x-maturity: - - GA /v1/Messaging/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -423,8 +447,8 @@ paths: - outbound_sms_prices - inbound_sms_prices - price_unit - pathType: instance parent: /Messaging + pathType: instance get: description: '' parameters: @@ -442,16 +466,33 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.messaging.messaging_country-instance' + examples: + fetch: + value: + country: country + inbound_sms_prices: + - base_price: '0.05' + current_price: '0.05' + number_type: mobile + iso_country: US + outbound_sms_prices: + - carrier: att + mcc: foo + mnc: bar + prices: + - base_price: '0.05' + current_price: '0.05' + number_type: mobile + price_unit: USD + url: https://pricing.twilio.com/v1/Messaging/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchMessagingCountry - x-maturity: - - GA /v1/PhoneNumbers: servers: - url: https://pricing.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - name @@ -464,8 +505,8 @@ paths: defaultOutputProperties: - country - price_unit - pathType: list parent: /PhoneNumbers + pathType: list get: description: '' parameters: @@ -501,34 +542,58 @@ paths: items: $ref: '#/components/schemas/pricing.v1.phone_number.phone_number_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Austria + iso_country: AT + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries/AT + meta: + page: 0 + page_size: 50 + first_page_url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 + previous_page_url: null + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 + next_page_url: null + key: countries + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumberCountry - x-maturity: - - GA /v1/PhoneNumbers/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -537,8 +602,8 @@ paths: defaultOutputProperties: - country - price_unit - pathType: instance parent: /PhoneNumbers + pathType: instance get: description: '' parameters: @@ -556,16 +621,28 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.phone_number.phone_number_country-instance' + examples: + fetch: + value: + country: United States + iso_country: US + phone_number_prices: + - number_type: local + base_price: '1.00' + current_price: '1.00' + - number_type: toll free + base_price: '2.00' + current_price: '2.00' + price_unit: USD + url: https://pricing.twilio.com/v1/PhoneNumbers/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumberCountry - x-maturity: - - GA /v1/Voice: servers: - url: https://pricing.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - name @@ -578,8 +655,8 @@ paths: defaultOutputProperties: - country - price_unit - pathType: list parent: /Voice + pathType: list get: description: '' parameters: @@ -615,34 +692,58 @@ paths: items: $ref: '#/components/schemas/pricing.v1.voice.voice_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Andorra + iso_country: AD + url: https://pricing.twilio.com/v1/Voice/Countries/AD + meta: + first_page_url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v1/Voice/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListVoiceCountry - x-maturity: - - GA /v1/Voice/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -651,8 +752,8 @@ paths: defaultOutputProperties: - country - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: '' parameters: @@ -670,12 +771,31 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.voice.voice_country-instance' + examples: + fetch: + value: + country: United States + inbound_call_prices: + - current_price: '0.0085' + number_type: local + base_price: '0.0085' + - current_price: '0.022' + number_type: toll free + base_price: '0.022' + iso_country: US + outbound_prefix_prices: + - prefixes: + - '1907' + current_price: '0.090' + friendly_name: Programmable Outbound Minute - United States + - Alaska + base_price: '0.090' + price_unit: USD + url: https://pricing.twilio.com/v1/Voice/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchVoiceCountry - x-maturity: - - GA /v1/Voice/Numbers/{Number}: servers: - url: https://pricing.twilio.com @@ -686,8 +806,8 @@ paths: - outbound_call_price - inbound_call_price - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: '' parameters: @@ -704,12 +824,25 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v1.voice.voice_number' + examples: + fetch: + value: + country: Iran + inbound_call_price: + base_price: null + current_price: null + number_type: null + iso_country: IR + number: '+987654321' + outbound_call_price: + base_price: '0.255' + current_price: '0.255' + price_unit: USD + url: https://pricing.twilio.com/v1/Voice/Numbers/+987654321 description: OK security: - accountSid_authToken: [] operationId: FetchVoiceNumber - x-maturity: - - GA /v1/Voice/Numbers: servers: - url: https://pricing.twilio.com @@ -720,10 +853,7 @@ paths: - outbound_call_price - inbound_call_price - price_unit - pathType: list parent: /Voice + pathType: list servers: - url: https://pricing.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index 3f04c06e..61c97cda 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: pricing.v2.trunking_country: type: object @@ -315,10 +319,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Pricing description: This is the public Twilio REST API. @@ -330,7 +330,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Trunking/Countries: @@ -377,34 +377,58 @@ paths: items: $ref: '#/components/schemas/pricing.v2.trunking_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Andorra + iso_country: AD + url: https://pricing.twilio.com/v2/Trunking/Countries/AD + meta: + first_page_url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Trunking/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTrunkingCountry - x-maturity: - - GA /v2/Trunking/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -431,12 +455,59 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v2.trunking_country-instance' + examples: + fetch: + value: + country: United States + originating_call_prices: + - base_price: null + current_price: '0.0085' + number_type: local + - base_price: null + current_price: '0.022' + number_type: toll free + iso_country: US + terminating_prefix_prices: + - base_price: null + current_price: '0.090' + destination_prefixes: + - '1907' + friendly_name: Outbound Trunking Minute - United States - Alaska + origination_prefixes: + - ALL + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1808' + friendly_name: Outbound Trunking Minute - United States - Hawaii + origination_prefixes: + - ALL + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1800' + - '1844' + - '1855' + - '1866' + - '1877' + - '1888' + friendly_name: Outbound Trunking Minute - United States & Canada + - Toll Free + origination_prefixes: + - ALL + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1' + friendly_name: Outbound Trunking Minute - United States & Canada + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Trunking/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchTrunkingCountry - x-maturity: - - GA /v2/Trunking/Numbers/{DestinationNumber}: servers: - url: https://pricing.twilio.com @@ -468,18 +539,62 @@ paths: schema: type: string format: phone-number + examples: + fetchWithOrigination: + value: '+15105556789' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pricing.v2.trunking_number' + examples: + fetch: + value: + country: United States + destination_number: '+18001234567' + originating_call_price: + base_price: null + current_price: null + number_type: null + iso_country: US + origination_number: null + terminating_prefix_prices: + - base_price: null + current_price: '0.013' + destination_prefixes: + - '1800' + friendly_name: Trunking Outbound Minute - United States Zone + 1b + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567 + fetchWithOrigination: + value: + country: United States + destination_number: '+18001234567' + originating_call_price: + base_price: null + current_price: '0.013' + number_type: tollfree + iso_country: US + origination_number: '+15105556789' + terminating_prefix_prices: + - base_price: null + current_price: '0.001' + destination_prefixes: + - '1800' + friendly_name: Trunking Outbound Minute - United States - Toll + Free + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Trunking/Numbers/+18001234567 description: OK security: - accountSid_authToken: [] operationId: FetchTrunkingNumber - x-maturity: - - GA /v2/Trunking/Numbers: servers: - url: https://pricing.twilio.com @@ -506,8 +621,8 @@ paths: defaultOutputProperties: - country - price_unit - pathType: list parent: /Voice + pathType: list get: description: '' parameters: @@ -543,34 +658,58 @@ paths: items: $ref: '#/components/schemas/pricing.v2.voice.voice_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + countries: + - country: Andorra + iso_country: AD + url: https://pricing.twilio.com/v2/Voice/Countries/AD + meta: + first_page_url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 + readEmpty: + value: + countries: [] + meta: + first_page_url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 + key: countries + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://pricing.twilio.com/v2/Voice/Countries?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListVoiceCountry - x-maturity: - - GA /v2/Voice/Countries/{IsoCountry}: servers: - url: https://pricing.twilio.com @@ -579,8 +718,8 @@ paths: defaultOutputProperties: - country - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: Fetch a specific Country. parameters: @@ -598,12 +737,62 @@ paths: application/json: schema: $ref: '#/components/schemas/pricing.v2.voice.voice_country-instance' + examples: + fetch: + value: + country: United States + inbound_call_prices: + - base_price: '0.0085' + current_price: '0.0085' + number_type: local + - base_price: '0.022' + current_price: '0.022' + number_type: toll free + iso_country: US + outbound_prefix_prices: + - base_price: '0.090' + current_price: '0.090' + destination_prefixes: + - '1907' + friendly_name: Programmable Outbound Minute - United States + - Alaska + origination_prefixes: + - ALL + - base_price: '0.013' + current_price: '0.013' + destination_prefixes: + - '1808' + friendly_name: Programmable Outbound Minute - United States + - Hawaii + origination_prefixes: + - ALL + - base_price: '0.013' + current_price: '0.013' + destination_prefixes: + - '1800' + - '1844' + - '1855' + - '1866' + - '1877' + - '1888' + friendly_name: Programmable Outbound Minute - United States + & Canada - Toll Free + origination_prefixes: + - ALL + - base_price: '0.013' + current_price: '0.013' + destination_prefixes: + - '1' + friendly_name: Programmable Outbound Minute - United States + & Canada + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Voice/Countries/US description: OK security: - accountSid_authToken: [] operationId: FetchVoiceCountry - x-maturity: - - GA /v2/Voice/Numbers/{DestinationNumber}: servers: - url: https://pricing.twilio.com @@ -613,8 +802,8 @@ paths: - country - inbound_call_price - price_unit - pathType: instance parent: /Voice + pathType: instance get: description: Fetch pricing information for a specific destination and, optionally, origination phone number. @@ -636,18 +825,37 @@ paths: schema: type: string format: phone-number + examples: + fetch: + value: '+18001234567' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pricing.v2.voice.voice_number' + examples: + fetch: + value: + country: United States + destination_number: '+18001234567' + inbound_call_price: + base_price: null + current_price: null + number_type: null + iso_country: US + origination_number: '+987654321' + outbound_call_prices: + - base_price: '0.013' + current_price: '0.013' + origination_prefixes: + - ALL + price_unit: USD + url: https://pricing.twilio.com/v2/Voice/Numbers/+18001234567 description: OK security: - accountSid_authToken: [] operationId: FetchVoiceNumber - x-maturity: - - GA /v2/Voice/Numbers: servers: - url: https://pricing.twilio.com @@ -657,10 +865,7 @@ paths: - country - inbound_call_price - price_unit - pathType: list parent: /Voice + pathType: list servers: - url: https://pricing.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index 358a454d..43394424 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: proxy.v1.service.session.interaction: type: object @@ -796,10 +800,6 @@ components: description: Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Proxy description: This is the public Twilio REST API. @@ -811,20 +811,20 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: instance parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: instance get: description: Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session). parameters: @@ -864,12 +864,32 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.interaction' + examples: + fetch: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: '{"body":"some message"}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + inbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_resource_status: sent + inbound_resource_type: Message + inbound_resource_url: null + outbound_participant_sid: KPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + outbound_resource_sid: SMbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + outbound_resource_status: sent + outbound_resource_type: Message + outbound_resource_url: null + sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: message + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchInteraction - x-maturity: - - Beta delete: description: Delete a specific Interaction. parameters: @@ -909,19 +929,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: list parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: list get: description: Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page. @@ -978,45 +996,55 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session.interaction' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + interactions: [] + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0 + page_size: 50 + key: interactions description: OK security: - accountSid_authToken: [] operationId: ListInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: list parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} + pathType: list post: description: Create a new message Interaction to send directly from your system to one [Participant](https://www.twilio.com/docs/proxy/api/participant). The @@ -1058,12 +1086,33 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' + examples: + create: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: '{"body":"some message"}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_participant_sid: null + inbound_resource_sid: null + inbound_resource_status: null + inbound_resource_type: null + inbound_resource_url: null + outbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_status: sent + outbound_resource_type: Message + outbound_resource_url: null + sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: message + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateMessageInteraction - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1080,6 +1129,10 @@ paths: type: string format: uri description: Reserved. Not currently supported. + examples: + create: + value: + Body: some message x-twilio: conditional: - - body @@ -1149,45 +1202,55 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + interactions: [] + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0 + page_size: 50 + key: interactions description: OK security: - accountSid_authToken: [] operationId: ListMessageInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - type - data - pathType: instance parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} + pathType: instance get: description: '' parameters: @@ -1237,27 +1300,48 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' + examples: + fetch: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: '{"body":"some message"}' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + inbound_participant_sid: null + inbound_resource_sid: null + inbound_resource_status: null + inbound_resource_type: null + inbound_resource_url: null + outbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + outbound_resource_status: sent + outbound_resource_type: Message + outbound_resource_url: null + sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: message + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchMessageInteraction - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier - pathType: instance dependentProperties: message_interaction: '{service_sid: service_sid, session_sid: session_sid, participant_sid: sid}' parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: instance get: description: Fetch a specific Participant. parameters: @@ -1297,12 +1381,43 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant' + examples: + fetch: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: '+14155551212' + proxy_identifier: '+14155559999' + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions + fetchChannel: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: messenger:14155551212 + proxy_identifier: messenger:14155559999 + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: a facebook user + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions description: OK security: - accountSid_authToken: [] operationId: FetchParticipant - x-maturity: - - Beta delete: description: Delete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are @@ -1345,23 +1460,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteParticipant - x-maturity: - - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier - pathType: list dependentProperties: message_interaction: '{service_sid: service_sid, session_sid: session_sid, participant_sid: sid}' parent: /Services/{ServiceSid}/Sessions/{Sid} + pathType: list get: description: Retrieve a list of all Participants in a Session. parameters: @@ -1417,34 +1530,44 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session.participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + page_size: 50 + key: participants + participants: [] description: OK security: - accountSid_authToken: [] operationId: ListParticipant - x-maturity: - - Beta post: description: Add a new Participant to the Session parameters: @@ -1474,12 +1597,43 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant' + examples: + create: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: '+14155551212' + proxy_identifier: '+14155559999' + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions + createChannel: + value: + sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identifier: messenger:123456 + proxy_identifier: messenger:987654532 + proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: a facebook user + date_deleted: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions description: Created security: - accountSid_authToken: [] operationId: CreateParticipant - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1507,17 +1661,27 @@ paths: description: The SID of the Proxy Identifier to assign to the Participant. required: - Identifier + examples: + create: + value: + FriendlyName: friendly_name + Identifier: '+14155551212' + createChannel: + value: + FriendlyName: a facebook user + Identifier: messenger:123456 + ProxyIdentifier: messenger:987654532 /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - phone_number - pathType: list parent: /Services/{Sid} + pathType: list post: description: Add a Phone Number to a Service's Proxy Number Pool. parameters: @@ -1537,12 +1701,27 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' + examples: + create: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '+1987654321' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false + in_use: 0 description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1571,6 +1750,10 @@ paths: not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. + examples: + create: + value: + Sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page. @@ -1617,45 +1800,69 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.phone_number' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: phone_numbers + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + phone_numbers: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '+1987654321' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false + in_use: 0 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber - x-maturity: - - Beta /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - phone_number - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: Delete a specific Phone Number from a Service. parameters: @@ -1685,8 +1892,6 @@ paths: security: - accountSid_authToken: [] operationId: DeletePhoneNumber - x-maturity: - - Beta get: description: Fetch a specific Phone Number. parameters: @@ -1716,12 +1921,27 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '12345' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false + in_use: 0 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - Beta post: description: Update a specific Proxy Number. parameters: @@ -1751,12 +1971,27 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' + examples: + update: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + phone_number: '12345' + friendly_name: Friendly Name + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: true + in_use: 0 description: OK security: - accountSid_authToken: [] operationId: UpdatePhoneNumber - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1770,20 +2005,24 @@ paths: be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. + examples: + update: + value: + IsReserved: true /v1/Services/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_created - pathType: instance dependentProperties: session: '{service_sid: sid}' phone_number: '{service_sid: sid}' short_code: '{service_sid: sid}' + pathType: instance get: description: Fetch a specific Service. parameters: @@ -1800,12 +2039,30 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' + examples: + fetch: + value: + sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My Service + default_ttl: 3600 + callback_url: http://www.example.com + geo_match_level: country + number_selection_behavior: prefer-sticky + intercept_callback_url: http://www.example.com + out_of_session_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions + phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta delete: description: Delete a specific Service. parameters: @@ -1825,8 +2082,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta post: description: Update a specific Service. parameters: @@ -1846,12 +2101,30 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' + examples: + update: + value: + sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My Service + default_ttl: 3600 + callback_url: http://www.example.com + geo_match_level: country + number_selection_behavior: prefer-sticky + intercept_callback_url: http://www.example.com + out_of_session_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions + phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1921,20 +2194,27 @@ paths: description: The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship. + examples: + update: + value: + DefaultTtl: 3600 + CallbackUrl: http://www.example.com + UniqueName: My Service + ChatInstanceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Services: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_created - pathType: list dependentProperties: session: '{service_sid: sid}' phone_number: '{service_sid: sid}' short_code: '{service_sid: sid}' + pathType: list get: description: Retrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page. @@ -1971,34 +2251,44 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + services: [] + meta: + first_page_url: https://proxy.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://proxy.twilio.com/v1/Services?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta post: description: Create a new Service for Twilio Proxy responses: @@ -2007,12 +2297,30 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' + examples: + create: + value: + sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My Service + default_ttl: 3600 + callback_url: http://www.example.com + geo_match_level: country + number_selection_behavior: prefer-sticky + intercept_callback_url: http://www.example.com + out_of_session_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions + phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + short_codes: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2084,21 +2392,28 @@ paths: messages to this chat instance. This is a one-to-one relationship. required: - UniqueName + examples: + create: + value: + DefaultTtl: 3600 + CallbackUrl: http://www.example.com + UniqueName: My Service + ChatInstanceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Services/{ServiceSid}/Sessions/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended - pathType: instance dependentProperties: interaction: '{service_sid: service_sid, session_sid: sid}' participant: '{service_sid: service_sid, session_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: Fetch a specific Session. parameters: @@ -2125,12 +2440,31 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' + examples: + fetch: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: open + unique_name: 'Order #1234' + date_started: '2015-07-30T20:00:00Z' + date_ended: '2015-07-30T20:00:00Z' + date_last_interaction: '2015-07-30T20:00:00Z' + date_expiry: '2015-07-30T20:00:00Z' + ttl: 3600 + mode: voice-and-message + closed_reason: '' + sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions + participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: FetchSession - x-maturity: - - Beta delete: description: Delete a specific Session. parameters: @@ -2160,8 +2494,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSession - x-maturity: - - Beta post: description: Update a specific Session. parameters: @@ -2191,12 +2523,31 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' + examples: + update: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: in-progress + unique_name: 'Order #1234' + date_started: '2015-07-30T20:00:00Z' + date_ended: '2015-07-30T20:00:00Z' + date_last_interaction: '2015-07-30T20:00:00Z' + date_expiry: '2015-07-30T20:00:00Z' + ttl: 3600 + mode: voice-and-message + closed_reason: '' + sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions + participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: OK security: - accountSid_authToken: [] operationId: UpdateSession - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2220,21 +2571,26 @@ paths: $ref: '#/components/schemas/session_enum_status' description: 'The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session.' + examples: + update: + value: + Ttl: 3600 + Status: in-progress /v1/Services/{ServiceSid}/Sessions: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended - pathType: list dependentProperties: interaction: '{service_sid: service_sid, session_sid: sid}' participant: '{service_sid: service_sid, session_sid: sid}' parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page. @@ -2281,34 +2637,44 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.session' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sessions: [] + meta: + previous_page_url: null + next_page_url: null + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0 + page: 0 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0 + page_size: 50 + key: sessions description: OK security: - accountSid_authToken: [] operationId: ListSession - x-maturity: - - Beta post: description: Create a new Session parameters: @@ -2328,12 +2694,31 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' + examples: + create: + value: + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: open + unique_name: 'Order #1234' + date_started: '2015-07-30T20:00:00Z' + date_ended: '2015-07-30T20:00:00Z' + date_last_interaction: '2015-07-30T20:00:00Z' + date_expiry: '2015-07-30T20:00:00Z' + ttl: 3600 + mode: voice-and-message + closed_reason: '' + sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_updated: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions + participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants description: Created security: - accountSid_authToken: [] operationId: CreateSession - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2372,17 +2757,22 @@ paths: type: array items: {} description: The Participant objects to include in the new session. + examples: + create: + value: + Ttl: 3600 + UniqueName: 'Order #1234' /v1/Services/{ServiceSid}/ShortCodes: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - short_code - iso_country - pathType: list parent: /Services/{Sid} + pathType: list post: description: Add a Short Code to the Proxy Number Pool for the Service. parameters: @@ -2402,12 +2792,25 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' + examples: + create: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false description: Created security: - accountSid_authToken: [] operationId: CreateShortCode - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2425,6 +2828,10 @@ paths: to your Proxy Service. required: - Sid + examples: + create: + value: + Sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Short Codes in the Proxy Number Pool for the Service. A maximum of 100 records will be returned per page. @@ -2471,45 +2878,67 @@ paths: items: $ref: '#/components/schemas/proxy.v1.service.short_code' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: short_codes + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + short_codes: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false description: OK security: - accountSid_authToken: [] operationId: ListShortCode - x-maturity: - - Beta /v1/Services/{ServiceSid}/ShortCodes/{Sid}: servers: - url: https://proxy.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - short_code - iso_country - pathType: instance parent: /Services/{Sid} + pathType: instance delete: description: Delete a specific Short Code from a Service. parameters: @@ -2539,8 +2968,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteShortCode - x-maturity: - - Beta get: description: Fetch a specific Short Code. parameters: @@ -2570,12 +2997,25 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' + examples: + fetch: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: false description: OK security: - accountSid_authToken: [] operationId: FetchShortCode - x-maturity: - - Beta post: description: Update a specific Short Code. parameters: @@ -2605,12 +3045,25 @@ paths: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' + examples: + update: + value: + sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + short_code: '12345' + iso_country: US + capabilities: + sms_outbound: true + voice_inbound: false + url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + is_reserved: true description: OK security: - accountSid_authToken: [] operationId: UpdateShortCode - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2624,9 +3077,9 @@ paths: assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. + examples: + update: + value: + IsReserved: true servers: - url: https://proxy.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_routes_v2.yaml b/spec/yaml/twilio_routes_v2.yaml index b308573e..401a8007 100644 --- a/spec/yaml/twilio_routes_v2.yaml +++ b/spec/yaml/twilio_routes_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: routes.v2.phone_number: type: object @@ -133,10 +137,6 @@ components: nullable: true description: The date that the Inbound Processing Region was updated for this SIP Trunk, given in ISO 8601 format. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Routes description: This is the public Twilio REST API. @@ -148,13 +148,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: servers: - url: https://routes.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -176,12 +176,21 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.phone_number' + examples: + update: + value: + phone_number: '+18001234567' + url: https://routes.twilio.com/v2/PhoneNumbers/+18001234567 + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: UpdatePhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -197,6 +206,11 @@ paths: type: string description: A human readable description of this resource, up to 64 characters. + examples: + update: + value: + FriendlyName: friendly_name + VoiceRegion: au1 get: description: Fetch the Inbound Processing Region assigned to a phone number. parameters: @@ -212,16 +226,25 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.phone_number' + examples: + fetch: + value: + phone_number: '+18001234567' + url: https://routes.twilio.com/v2/PhoneNumbers/+18001234567 + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - GA /v2/SipDomains/{SipDomain}: servers: - url: https://routes.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -243,12 +266,21 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.sip_domain' + examples: + update: + value: + url: https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com + sip_domain: test.sip.twilio.com + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2020-08-07T22:29:24Z' + date_updated: '2020-08-07T22:29:24Z' description: OK security: - accountSid_authToken: [] operationId: UpdateSipDomain - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -262,6 +294,11 @@ paths: FriendlyName: type: string description: '' + examples: + update: + value: + FriendlyName: friendly_name + VoiceRegion: au1 get: description: '' parameters: @@ -277,16 +314,25 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.sip_domain' + examples: + fetch: + value: + url: https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com + account_sid: AC00000000000000000000000000000000 + sid: QQ00000000000000000000000000000000 + sip_domain: test.sip.twilio.com + friendly_name: string + voice_region: string + date_created: '2022-06-02T22:33:47Z' + date_updated: '2022-06-02T22:33:47Z' description: OK security: - accountSid_authToken: [] operationId: FetchSipDomain - x-maturity: - - GA /v2/Trunks/{SipTrunkDomain}: servers: - url: https://routes.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -308,12 +354,21 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.trunks' + examples: + update: + value: + sip_trunk_domain: test.pstn.twilio.com + url: https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com + sid: QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_region: au1 + date_created: '2020-08-07T22:29:24Z' + date_updated: '2020-08-07T22:29:24Z' description: OK security: - accountSid_authToken: [] operationId: UpdateTrunks - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -329,6 +384,11 @@ paths: type: string description: A human readable description of this resource, up to 64 characters. + examples: + update: + value: + FriendlyName: friendly_name + VoiceRegion: au1 get: description: Fetch the Inbound Processing Region assigned to a SIP Trunk. parameters: @@ -344,14 +404,20 @@ paths: application/json: schema: $ref: '#/components/schemas/routes.v2.trunks' + examples: + fetch: + value: + sip_trunk_domain: test.pstn.twilio.com + url: https://routes.twilio.com/v2/Trunks/test.pstn.twilio.com + account_sid: AC00000000000000000000000000000000 + sid: QQ00000000000000000000000000000000 + friendly_name: string + voice_region: string + date_created: '2022-06-02T22:33:47Z' + date_updated: '2022-06-02T22:33:47Z' description: OK security: - accountSid_authToken: [] operationId: FetchTrunks - x-maturity: - - GA servers: - url: https://routes.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index 357e8469..f119863e 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: serverless.v1.service.asset: type: object @@ -769,10 +773,6 @@ components: format: uri nullable: true description: The absolute URL of the Variable resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Serverless description: This is the public Twilio REST API. @@ -784,7 +784,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Assets: @@ -797,10 +797,10 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: asset_version: '{service_sid: service_sid, asset_sid: sid}' parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Assets. parameters: @@ -842,34 +842,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.asset' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + assets: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0 + key: assets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAsset - x-maturity: - - Beta post: description: Create a new Asset resource. parameters: @@ -885,12 +895,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' + examples: + create: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: asset-friendly + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000 + links: + asset_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions description: Created security: - accountSid_authToken: [] operationId: CreateAsset - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -904,6 +924,10 @@ paths: Asset resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + create: + value: + FriendlyName: asset-friendly /v1/Services/{ServiceSid}/Assets/{Sid}: servers: - url: https://serverless.twilio.com @@ -914,10 +938,10 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: asset_version: '{service_sid: service_sid, asset_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific Asset resource. parameters: @@ -942,12 +966,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' + examples: + fetch: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: test-asset + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000 + links: + asset_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: FetchAsset - x-maturity: - - Beta delete: description: Delete an Asset resource. parameters: @@ -972,8 +1006,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteAsset - x-maturity: - - Beta post: description: Update a specific Asset resource. parameters: @@ -998,12 +1030,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' + examples: + update: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: asset-friendly-update + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000 + links: + asset_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: UpdateAsset - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1017,6 +1059,10 @@ paths: Asset resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + update: + value: + FriendlyName: asset-friendly-update /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions: servers: - url: https://serverless.twilio.com @@ -1027,9 +1073,9 @@ paths: - path - visibility - date_created - pathType: list parent: /Services/{ServiceSid}/Assets/{Sid} mountName: asset_versions + pathType: list get: description: Retrieve a list of all Asset Versions. parameters: @@ -1081,34 +1127,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.asset.asset_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + asset_versions: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 + key: asset_versions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAssetVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}: servers: - url: https://serverless.twilio.com @@ -1119,9 +1175,9 @@ paths: - path - visibility - date_created - pathType: instance parent: /Services/{ServiceSid}/Assets/{Sid} mountName: asset_versions + pathType: instance get: description: Retrieve a specific Asset Version. parameters: @@ -1156,12 +1212,21 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset.asset_version' + examples: + fetch: + value: + sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_sid: ZH00000000000000000000000000000000 + path: /test-path + visibility: public + date_created: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchAssetVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Builds: servers: - url: https://serverless.twilio.com @@ -1172,10 +1237,10 @@ paths: - sid - status - date_created - pathType: list dependentProperties: build_status: '{service_sid: service_sid, sid: sid}' parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Builds. parameters: @@ -1217,34 +1282,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.build' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + builds: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0 + key: builds + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListBuild - x-maturity: - - Beta post: description: Create a new Build resource. At least one function version or asset version is required. @@ -1261,12 +1336,44 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build' + examples: + create: + value: + sid: ZB00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_versions: + - sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_sid: ZH00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + path: /asset-path + visibility: PUBLIC + function_versions: + - sid: ZN00000000000000000000000000000001 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000001 + date_created: '2018-11-10T20:00:00Z' + path: /function-path + visibility: PUBLIC + dependencies: + - name: twilio + version: 3.29.2 + - name: '@twilio/runtime-handler' + version: 1.0.1 + runtime: node16 + status: building + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000 + links: + build_status: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status description: Created security: - accountSid_authToken: [] operationId: CreateBuild - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1301,6 +1408,15 @@ paths: type: string description: The Runtime version that will be used to run the Build resource when it is deployed. + examples: + create: + value: + AssetVersions: + - ZN00000000000000000000000000000000 + FunctionVersions: + - ZN00000000000000000000000000000001 + Dependencies: '[{"name":"twilio", "version":"3.29.2"}, {"name":"@twilio/runtime-handler", + "version": "1.0.1"}]' /v1/Services/{ServiceSid}/Builds/{Sid}: servers: - url: https://serverless.twilio.com @@ -1311,10 +1427,10 @@ paths: - sid - status - date_created - pathType: instance dependentProperties: build_status: '{service_sid: service_sid, sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific Build resource. parameters: @@ -1339,12 +1455,44 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build' + examples: + fetch: + value: + sid: ZB00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_versions: + - sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + asset_sid: ZH00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + path: /asset-path + visibility: PUBLIC + function_versions: + - sid: ZN00000000000000000000000000000001 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000001 + date_created: '2018-11-10T20:00:00Z' + path: /function-path + visibility: PUBLIC + dependencies: + - name: twilio + version: 3.29.2 + - name: '@twilio/runtime-handler' + version: 1.0.1 + runtime: node16 + status: building + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000 + links: + build_status: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status description: OK security: - accountSid_authToken: [] operationId: FetchBuild - x-maturity: - - Beta delete: description: Delete a Build resource. parameters: @@ -1369,8 +1517,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBuild - x-maturity: - - Beta /v1/Services/{ServiceSid}/Builds/{Sid}/Status: servers: - url: https://serverless.twilio.com @@ -1379,9 +1525,9 @@ paths: defaultOutputProperties: - sid - status - pathType: instance parent: /Services/{ServiceSid}/Builds/{Sid} mountName: build_status + pathType: instance get: description: Retrieve a specific Build resource. parameters: @@ -1406,12 +1552,18 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build.build_status' + examples: + fetch: + value: + sid: ZB00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + status: completed + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status description: OK security: - accountSid_authToken: [] operationId: FetchBuildStatus - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments: servers: - url: https://serverless.twilio.com @@ -1422,8 +1574,8 @@ paths: - sid - build_sid - date_created - pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: list get: description: Retrieve a list of all Deployments. parameters: @@ -1475,34 +1627,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + deployments: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDeployment - x-maturity: - - Beta post: description: Create a new Deployment. parameters: @@ -1527,12 +1689,21 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' + examples: + create: + value: + sid: ZD00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000 description: Created security: - accountSid_authToken: [] operationId: CreateDeployment - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1546,6 +1717,10 @@ paths: maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ description: The SID of the Build for the Deployment. + examples: + create: + value: + BuildSid: ZB00000000000000000000000000000000 /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid}: servers: - url: https://serverless.twilio.com @@ -1556,8 +1731,8 @@ paths: - sid - build_sid - date_created - pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: instance get: description: Retrieve a specific Deployment. parameters: @@ -1591,12 +1766,21 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' + examples: + fetch: + value: + sid: ZD00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchDeployment - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments: servers: - url: https://serverless.twilio.com @@ -1608,12 +1792,12 @@ paths: - unique_name - domain_name - build_sid - pathType: list dependentProperties: variable: '{service_sid: service_sid, environment_sid: sid}' deployment: '{service_sid: service_sid, environment_sid: sid}' log: '{service_sid: service_sid, environment_sid: sid}' parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all environments. parameters: @@ -1655,34 +1839,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + environments: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0 + key: environments + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEnvironment - x-maturity: - - Beta post: description: Create a new environment. parameters: @@ -1698,12 +1892,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment' + examples: + create: + value: + sid: ZE00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + build_sid: null + unique_name: staging + domain_suffix: stage + domain_name: foobar-1234-stage.twil.io + custom_domain_name: null + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000 + links: + variables: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables + deployments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments + logs: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs description: Created security: - accountSid_authToken: [] operationId: CreateEnvironment - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1721,6 +1931,11 @@ paths: and forms part of the domain name. It can be a maximum of 16 characters. required: - UniqueName + examples: + create: + value: + UniqueName: staging + DomainSuffix: stage /v1/Services/{ServiceSid}/Environments/{Sid}: servers: - url: https://serverless.twilio.com @@ -1732,12 +1947,12 @@ paths: - unique_name - domain_name - build_sid - pathType: instance dependentProperties: variable: '{service_sid: service_sid, environment_sid: sid}' deployment: '{service_sid: service_sid, environment_sid: sid}' log: '{service_sid: service_sid, environment_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific environment. parameters: @@ -1762,12 +1977,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment' + examples: + fetch: + value: + sid: ZE00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + unique_name: testing-environment + domain_suffix: testing + domain_name: foobar-1234-testing.twil.io + custom_domain_name: null + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000 + links: + variables: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables + deployments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments + logs: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs description: OK security: - accountSid_authToken: [] operationId: FetchEnvironment - x-maturity: - - Beta delete: description: Delete a specific environment. parameters: @@ -1792,8 +2023,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEnvironment - x-maturity: - - Beta /v1/Services/{ServiceSid}/Functions: servers: - url: https://serverless.twilio.com @@ -1804,10 +2033,10 @@ paths: - sid - friendly_name - date_created - pathType: list dependentProperties: function_version: '{service_sid: service_sid, function_sid: sid}' parent: /Services/{Sid} + pathType: list get: description: Retrieve a list of all Functions. parameters: @@ -1849,34 +2078,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.function' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + functions: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0 + key: functions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListFunction - x-maturity: - - Beta post: description: Create a new Function resource. parameters: @@ -1892,12 +2131,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' + examples: + create: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: function-friendly + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000 + links: + function_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions description: Created security: - accountSid_authToken: [] operationId: CreateFunction - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1911,6 +2160,10 @@ paths: Function resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + create: + value: + FriendlyName: function-friendly /v1/Services/{ServiceSid}/Functions/{Sid}: servers: - url: https://serverless.twilio.com @@ -1921,10 +2174,10 @@ paths: - sid - friendly_name - date_created - pathType: instance dependentProperties: function_version: '{service_sid: service_sid, function_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: Retrieve a specific Function resource. parameters: @@ -1949,12 +2202,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' + examples: + fetch: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: test-function + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000 + links: + function_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: FetchFunction - x-maturity: - - Beta delete: description: Delete a Function resource. parameters: @@ -1979,8 +2242,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFunction - x-maturity: - - Beta post: description: Update a specific Function resource. parameters: @@ -2005,12 +2266,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' + examples: + update: + value: + sid: ZH00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + friendly_name: function-friendly-update + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000 + links: + function_versions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions description: OK security: - accountSid_authToken: [] operationId: UpdateFunction - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2024,6 +2295,10 @@ paths: Function resource. It can be a maximum of 255 characters. required: - FriendlyName + examples: + update: + value: + FriendlyName: function-friendly-update /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions: servers: - url: https://serverless.twilio.com @@ -2034,12 +2309,12 @@ paths: - path - visibility - date_created - pathType: list dependentProperties: function_version_content: '{service_sid: service_sid, function_sid: function_sid, sid: sid}' parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions + pathType: list get: description: Retrieve a list of all Function Version resources. parameters: @@ -2092,34 +2367,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.function.function_version' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + function_versions: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 + key: function_versions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListFunctionVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}: servers: - url: https://serverless.twilio.com @@ -2130,12 +2415,12 @@ paths: - path - visibility - date_created - pathType: instance dependentProperties: function_version_content: '{service_sid: service_sid, function_sid: function_sid, sid: sid}' parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions + pathType: instance get: description: Retrieve a specific Function Version resource. parameters: @@ -2171,12 +2456,23 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function.function_version' + examples: + fetch: + value: + sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000000 + path: /test-path + visibility: public + date_created: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000 + links: + function_version_content: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content description: OK security: - accountSid_authToken: [] operationId: FetchFunctionVersion - x-maturity: - - Beta /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content: servers: - url: https://serverless.twilio.com @@ -2185,9 +2481,9 @@ paths: defaultOutputProperties: - sid - content - pathType: instance parent: /Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid} mountName: function_version_content + pathType: instance get: description: Retrieve a the content of a specific Function Version resource. parameters: @@ -2223,20 +2519,30 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function.function_version.function_version_content' + examples: + fetch: + value: + sid: ZN00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000000 + content: "exports.handler = function (context, event, callback)\ + \ {\n const request = require(\"request\");\n return request(\"\ + http://www.google.com\", function (error, response, body) {\n\ + \ callback(null, response.statusCode);\n });\n};" + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content description: OK security: - accountSid_authToken: [] operationId: FetchFunctionVersionContent - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs: servers: - url: https://serverless.twilio.com description: A record of an event that occurred related to a function invocation. x-twilio: defaultOutputProperties: [] - pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: list get: description: Retrieve a list of all logs. parameters: @@ -2264,6 +2570,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: ZH00000000000000000000000000000000 - name: StartDate in: query description: The date/time (in GMT, ISO 8601) after which the Log resources @@ -2271,6 +2580,9 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2018-11-10T20:00:00Z' - name: EndDate in: query description: The date/time (in GMT, ISO 8601) before which the Log resources @@ -2278,6 +2590,9 @@ paths: schema: type: string format: date-time + examples: + readEmpty: + value: '2018-12-10T20:00:00Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2310,42 +2625,52 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment.log' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + logs: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0 + key: logs + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListLog - x-maturity: - - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}: servers: - url: https://serverless.twilio.com description: A record of an event that occurred related to a function invocation. x-twilio: defaultOutputProperties: [] - pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: instance get: description: Retrieve a specific log. parameters: @@ -2379,12 +2704,25 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.log' + examples: + fetch: + value: + sid: NO00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + build_sid: ZB00000000000000000000000000000000 + deployment_sid: ZD00000000000000000000000000000000 + function_sid: ZH00000000000000000000000000000000 + request_sid: RQ00000000000000000000000000000000 + level: warn + message: This is a warning + date_created: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs/NO00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchLog - x-maturity: - - Beta /v1/Services: servers: - url: https://serverless.twilio.com @@ -2395,12 +2733,12 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: environment: '{service_sid: sid}' function: '{service_sid: sid}' asset: '{service_sid: sid}' build: '{service_sid: sid}' + pathType: list get: description: Retrieve a list of all Services. parameters: @@ -2436,34 +2774,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + services: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - Beta post: description: Create a new Service resource. responses: @@ -2472,12 +2820,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service' + examples: + create: + value: + sid: ZS00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: service-friendly + unique_name: service-unique + include_credentials: true + ui_editable: false + domain_base: service-unique-1234 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000 + links: + environments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments + functions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions + assets: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets + builds: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2506,6 +2870,11 @@ paths: required: - UniqueName - FriendlyName + examples: + create: + value: + FriendlyName: service-friendly + UniqueName: service-unique /v1/Services/{Sid}: servers: - url: https://serverless.twilio.com @@ -2516,12 +2885,12 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: environment: '{service_sid: sid}' function: '{service_sid: sid}' asset: '{service_sid: sid}' build: '{service_sid: sid}' + pathType: instance get: description: Retrieve a specific Service resource. parameters: @@ -2537,12 +2906,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service' + examples: + fetch: + value: + sid: ZS00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: test-service + unique_name: test-service-1 + include_credentials: true + ui_editable: false + domain_base: test-service-1-1234 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000 + links: + environments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments + functions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions + assets: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets + builds: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - Beta delete: description: Delete a Service resource. parameters: @@ -2558,8 +2943,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - Beta post: description: Update a specific Service resource. parameters: @@ -2575,12 +2958,28 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service' + examples: + update: + value: + sid: ZS00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: service-friendly-update + unique_name: service-unique-update + include_credentials: true + ui_editable: true + domain_base: service-unique-update-1234 + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000 + links: + environments: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments + functions: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions + assets: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets + builds: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2600,6 +2999,12 @@ paths: type: boolean description: Whether the Service resource's properties and subresources can be edited via the UI. The default value is `false`. + examples: + update: + value: + FriendlyName: service-friendly-update + IncludeCredentials: true + UiEditable: true /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables: servers: - url: https://serverless.twilio.com @@ -2609,8 +3014,8 @@ paths: - sid - key - date_created - pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: list get: description: Retrieve a list of all Variables. parameters: @@ -2661,34 +3066,44 @@ paths: items: $ref: '#/components/schemas/serverless.v1.service.environment.variable' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + variables: [] + meta: + first_page_url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0 + key: variables + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListVariable - x-maturity: - - Beta post: description: Create a new Variable. parameters: @@ -2713,12 +3128,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' + examples: + create: + value: + sid: ZV00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + key: new-key + value: new-value + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000 description: Created security: - accountSid_authToken: [] operationId: CreateVariable - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2737,6 +3162,11 @@ paths: required: - Key - Value + examples: + create: + value: + Key: new-key + Value: new-value /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}: servers: - url: https://serverless.twilio.com @@ -2746,8 +3176,8 @@ paths: - sid - key - date_created - pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} + pathType: instance get: description: Retrieve a specific Variable. parameters: @@ -2781,12 +3211,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' + examples: + fetch: + value: + sid: ZV00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + key: test-key + value: test-value + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-10T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: FetchVariable - x-maturity: - - Beta post: description: Update a specific Variable. parameters: @@ -2820,12 +3260,22 @@ paths: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' + examples: + update: + value: + sid: ZV00000000000000000000000000000000 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ZS00000000000000000000000000000000 + environment_sid: ZE00000000000000000000000000000000 + key: update-key + value: update-value + date_created: '2018-11-10T20:00:00Z' + date_updated: '2018-11-11T20:00:00Z' + url: https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000 description: OK security: - accountSid_authToken: [] operationId: UpdateVariable - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2841,6 +3291,11 @@ paths: type: string description: A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size. + examples: + update: + value: + Key: update-key + Value: update-value delete: description: Delete a specific Variable. parameters: @@ -2874,11 +3329,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteVariable - x-maturity: - - Beta servers: - url: https://serverless.twilio.com -x-maturity: -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index cc5ed58b..49ee5b6f 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: studio.v1.flow.engagement: type: object @@ -516,10 +520,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Studio description: This is the public Twilio REST API. @@ -531,7 +531,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Flows/{FlowSid}/Engagements: @@ -544,11 +544,11 @@ paths: - contact_sid - status - date_created - pathType: list dependentProperties: step: '{flow_sid: flow_sid, engagement_sid: sid}' engagement_context: '{flow_sid: flow_sid, engagement_sid: sid}' parent: /Flows/{Sid} + pathType: list get: description: Retrieve a list of all Engagements for the Flow. parameters: @@ -593,34 +593,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.engagement' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0 + page_size: 50 + key: engagements + engagements: [] description: OK security: - accountSid_authToken: [] operationId: ListEngagement - x-maturity: - - GA post: description: Triggers a new Engagement for the Flow parameters: @@ -639,12 +649,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement' + examples: + create: + value: + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+18001234567' + status: active + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + engagement_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: Created security: - accountSid_authToken: [] operationId: CreateEngagement - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -674,6 +698,12 @@ paths: required: - To - From + examples: + create: + value: + To: '+18001234567' + From: '+18007654321' + Parameters: '{"first_name":"Foo"}' /v1/Flows/{FlowSid}/Engagements/{Sid}: servers: - url: https://studio.twilio.com @@ -684,11 +714,11 @@ paths: - contact_sid - status - date_created - pathType: instance dependentProperties: step: '{flow_sid: flow_sid, engagement_sid: sid}' engagement_context: '{flow_sid: flow_sid, engagement_sid: sid}' parent: /Flows/{Sid} + pathType: instance get: description: Retrieve an Engagement parameters: @@ -716,12 +746,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement' + examples: + fetch: + value: + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + context: {} + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + engagement_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchEngagement - x-maturity: - - GA delete: description: Delete this Engagement and all Steps relating to it. parameters: @@ -749,8 +793,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEngagement - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context: servers: - url: https://studio.twilio.com @@ -758,9 +800,9 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Engagements/{Sid} mountName: engagement_context + pathType: instance get: description: Retrieve the most recent context for an Engagement. parameters: @@ -788,12 +830,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.engagement_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchEngagementContext - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions: servers: - url: https://studio.twilio.com @@ -804,11 +853,11 @@ paths: - contact_sid - status - date_created - pathType: list dependentProperties: execution_step: '{flow_sid: flow_sid, execution_sid: sid}' execution_context: '{flow_sid: flow_sid, execution_sid: sid}' parent: /Flows/{Sid} + pathType: list get: description: Retrieve a list of all Executions for the Flow. parameters: @@ -867,34 +916,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.execution' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page_size: 50 + key: executions + executions: [] description: OK security: - accountSid_authToken: [] operationId: ListExecution - x-maturity: - - GA post: description: Triggers a new Execution for the Flow parameters: @@ -913,12 +972,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' + examples: + create: + value: + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+18001234567' + status: active + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: Created security: - accountSid_authToken: [] operationId: CreateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -949,6 +1022,12 @@ paths: required: - To - From + examples: + create: + value: + To: '+18001234567' + From: '+18007654321' + Parameters: '{"first_name":"Foo"}' /v1/Flows/{FlowSid}/Executions/{Sid}: servers: - url: https://studio.twilio.com @@ -959,11 +1038,11 @@ paths: - contact_sid - status - date_created - pathType: instance dependentProperties: execution_step: '{flow_sid: flow_sid, execution_sid: sid}' execution_context: '{flow_sid: flow_sid, execution_sid: sid}' parent: /Flows/{Sid} + pathType: instance get: description: Retrieve an Execution parameters: @@ -991,12 +1070,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' + examples: + fetch: + value: + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + context: {} + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecution - x-maturity: - - GA delete: description: Delete the Execution and all Steps relating to it. parameters: @@ -1024,8 +1117,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteExecution - x-maturity: - - GA post: description: Update the status of an Execution to `ended`. parameters: @@ -1053,12 +1144,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' + examples: + update: + value: + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + links: + steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: UpdateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1072,6 +1177,10 @@ paths: description: The status of the Execution. Can only be `ended`. required: - Status + examples: + update: + value: + Status: ended /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: servers: - url: https://studio.twilio.com @@ -1079,9 +1188,9 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{Sid} mountName: execution_context + pathType: instance get: description: Retrieve the most recent context for an Execution. parameters: @@ -1109,12 +1218,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionContext - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: servers: - url: https://studio.twilio.com @@ -1124,12 +1240,12 @@ paths: - sid - name - date_created - pathType: list dependentProperties: execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}' parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: list get: description: Retrieve a list of all Steps for an Execution. parameters: @@ -1183,34 +1299,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page_size: 50 + key: steps + steps: [] description: OK security: - accountSid_authToken: [] operationId: ListExecutionStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com @@ -1220,12 +1346,12 @@ paths: - sid - name - date_created - pathType: instance dependentProperties: execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}' parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: instance get: description: Retrieve a Step. parameters: @@ -1262,12 +1388,27 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step' + examples: + fetch: + value: + sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + parent_step_sid: null + name: incomingRequest + context: {} + transitioned_from: Trigger + transitioned_to: Ended + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + step_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com @@ -1275,10 +1416,10 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} mountName: step_context className: execution_step_context + pathType: instance get: description: Retrieve the context for an Execution Step. parameters: @@ -1315,12 +1456,20 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStepContext - x-maturity: - - GA /v1/Flows: servers: - url: https://studio.twilio.com @@ -1331,10 +1480,10 @@ paths: - friendly_name - status - version - pathType: list dependentProperties: engagement: '{flow_sid: sid}' execution: '{flow_sid: sid}' + pathType: list get: description: Retrieve a list of all Flows. parameters: @@ -1370,34 +1519,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows?PageSize=50&Page=0 + page_size: 50 + key: flows + flows: [] description: OK security: - accountSid_authToken: [] operationId: ListFlow - x-maturity: - - GA /v1/Flows/{Sid}: servers: - url: https://studio.twilio.com @@ -1408,10 +1567,10 @@ paths: - friendly_name - status - version - pathType: instance dependentProperties: engagement: '{flow_sid: sid}' execution: '{flow_sid: sid}' + pathType: instance get: description: Retrieve a specific Flow. parameters: @@ -1430,12 +1589,24 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + status: published + version: 1 + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + engagements: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements + executions: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: FetchFlow - x-maturity: - - GA delete: description: Delete a specific Flow. parameters: @@ -1454,8 +1625,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFlow - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps: servers: - url: https://studio.twilio.com @@ -1466,11 +1635,11 @@ paths: - name - transitioned_from - transitioned_to - pathType: list dependentProperties: step_context: '{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: sid}' parent: /Flows/{FlowSid}/Engagements/{Sid} + pathType: list get: description: Retrieve a list of all Steps for an Engagement. parameters: @@ -1524,34 +1693,44 @@ paths: items: $ref: '#/components/schemas/studio.v1.flow.engagement.step' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page_size: 50 + key: steps + steps: [] description: OK security: - accountSid_authToken: [] operationId: ListStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com @@ -1562,11 +1741,11 @@ paths: - name - transitioned_from - transitioned_to - pathType: instance dependentProperties: step_context: '{flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: sid}' parent: /Flows/{FlowSid}/Engagements/{Sid} + pathType: instance get: description: Retrieve a Step. parameters: @@ -1603,12 +1782,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.step' + examples: + fetch: + value: + sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: incomingRequest + context: {} + transitioned_from: Trigger + transitioned_to: Ended + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + step_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchStep - x-maturity: - - GA /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com @@ -1616,9 +1809,9 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid} mountName: step_context + pathType: instance get: description: Retrieve the context for an Engagement Step. parameters: @@ -1655,14 +1848,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.step.step_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchStepContext - x-maturity: - - GA servers: - url: https://studio.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 9f74cdf6..717fa100 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: studio.v2.flow.execution: type: object @@ -409,10 +413,6 @@ components: format: uri nullable: true description: The URL of this resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Studio description: This is the public Twilio REST API. @@ -424,7 +424,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Flows/{FlowSid}/Executions: @@ -436,11 +436,11 @@ paths: - sid - status - date_created - pathType: list dependentProperties: execution_step: '{flow_sid: flow_sid, execution_sid: sid}' execution_context: '{flow_sid: flow_sid, execution_sid: sid}' parent: /Flows/{Sid} + pathType: list get: description: Retrieve a list of all Executions for the Flow. parameters: @@ -499,34 +499,44 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow.execution' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 + page_size: 50 + key: executions + executions: [] description: OK security: - accountSid_authToken: [] operationId: ListExecution - x-maturity: - - GA post: description: Triggers a new Execution for the Flow parameters: @@ -545,12 +555,25 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution' + examples: + create: + value: + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_channel_address: '+18001234567' + status: active + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + steps: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: Created security: - accountSid_authToken: [] operationId: CreateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -581,6 +604,12 @@ paths: required: - To - From + examples: + create: + value: + To: '+18001234567' + From: '+18007654321' + Parameters: '{"first_name":"Foo"}' /v2/Flows/{FlowSid}/Executions/{Sid}: servers: - url: https://studio.twilio.com @@ -590,11 +619,11 @@ paths: - sid - status - date_created - pathType: instance dependentProperties: execution_step: '{flow_sid: flow_sid, execution_sid: sid}' execution_context: '{flow_sid: flow_sid, execution_sid: sid}' parent: /Flows/{Sid} + pathType: instance get: description: Retrieve an Execution parameters: @@ -622,12 +651,25 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution' + examples: + fetch: + value: + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + contact_channel_address: '+14155555555' + status: ended + context: {} + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + steps: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecution - x-maturity: - - GA delete: description: Delete the Execution and all Steps relating to it. parameters: @@ -655,8 +697,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteExecution - x-maturity: - - GA post: description: Update the status of an Execution to `ended`. parameters: @@ -684,12 +724,25 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution' + examples: + update: + value: + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: {} + contact_channel_address: '+14155555555' + status: ended + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + links: + steps: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps + execution_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: UpdateExecution - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -703,6 +756,10 @@ paths: description: The status of the Execution. Can only be `ended`. required: - Status + examples: + update: + value: + Status: ended /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: servers: - url: https://studio.twilio.com @@ -710,9 +767,9 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{Sid} mountName: execution_context + pathType: instance get: description: Retrieve the most recent context for an Execution. parameters: @@ -740,12 +797,19 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution.execution_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionContext - x-maturity: - - GA /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: servers: - url: https://studio.twilio.com @@ -755,12 +819,12 @@ paths: - sid - name - date_created - pathType: list dependentProperties: execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}' parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: list get: description: Retrieve a list of all Steps for an Execution. parameters: @@ -814,34 +878,44 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 + page_size: 50 + key: steps + steps: [] description: OK security: - accountSid_authToken: [] operationId: ListExecutionStep - x-maturity: - - GA /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com @@ -851,12 +925,12 @@ paths: - sid - name - date_created - pathType: instance dependentProperties: execution_step_context: '{flow_sid: flow_sid, execution_sid: execution_sid, step_sid: sid}' parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step + pathType: instance get: description: Retrieve a Step. parameters: @@ -893,12 +967,27 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution.execution_step' + examples: + fetch: + value: + sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + parent_step_sid: null + name: incomingRequest + context: {} + transitioned_from: Trigger + transitioned_to: Ended + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + step_context: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStep - x-maturity: - - GA /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com @@ -906,10 +995,10 @@ paths: x-twilio: defaultOutputProperties: - context - pathType: instance parent: /Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} mountName: step_context className: execution_step_context + pathType: instance get: description: Retrieve the context for an Execution Step. parameters: @@ -946,12 +1035,20 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + context: + foo: bar + flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context description: OK security: - accountSid_authToken: [] operationId: FetchExecutionStepContext - x-maturity: - - GA /v2/Flows: servers: - url: https://studio.twilio.com @@ -962,11 +1059,11 @@ paths: - friendly_name - status - revision - pathType: list dependentProperties: flow_revision: '{sid: sid}' flow_test_user: '{sid: sid}' execution: '{flow_sid: sid}' + pathType: list post: description: Create a Flow. responses: @@ -975,12 +1072,32 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow' + examples: + create: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + definition: + initial_state: Trigger + friendly_name: Test Flow + status: published + revision: 1 + commit_message: null + valid: true + errors: [] + warnings: [] + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: Created security: - accountSid_authToken: [] operationId: CreateFlow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1004,6 +1121,12 @@ paths: - FriendlyName - Status - Definition + examples: + create: + value: + FriendlyName: Test Flow + Status: published + Definition: '{"initial_state": "Trigger"}' get: description: Retrieve a list of all Flows. parameters: @@ -1039,34 +1162,62 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows?PageSize=50&Page=0 + page_size: 50 + key: flows + flows: + - sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + status: published + revision: 1 + definition: null + commit_message: null + valid: null + errors: null + warnings: null + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: ListFlow - x-maturity: - - GA /v2/Flows/{Sid}: servers: - url: https://studio.twilio.com @@ -1077,11 +1228,11 @@ paths: - friendly_name - status - revision - pathType: instance dependentProperties: flow_revision: '{sid: sid}' flow_test_user: '{sid: sid}' execution: '{flow_sid: sid}' + pathType: instance post: description: Update a Flow. parameters: @@ -1100,12 +1251,32 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow' + examples: + update: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + definition: + initial_state: Trigger + friendly_name: Test Flow + status: published + revision: 1 + commit_message: null + valid: true + errors: [] + warnings: [] + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: UpdateFlow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1127,6 +1298,12 @@ paths: description: Description of change made in the revision. required: - Status + examples: + update: + value: + FriendlyName: Test Flow + Status: published + Definition: '{"initial_state": "Trigger"}' get: description: Retrieve a specific Flow. parameters: @@ -1145,12 +1322,32 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + definition: + initial_state: Trigger + status: published + revision: 1 + commit_message: commit + valid: true + errors: [] + warnings: [] + webhook_url: http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + test_users: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers + revisions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions + executions: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions description: OK security: - accountSid_authToken: [] operationId: FetchFlow - x-maturity: - - GA delete: description: Delete a specific Flow. parameters: @@ -1169,8 +1366,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFlow - x-maturity: - - GA /v2/Flows/{Sid}/Revisions: servers: - url: https://studio.twilio.com @@ -1181,9 +1376,9 @@ paths: - friendly_name - status - revision - pathType: list parent: /Flows/{Sid} className: flow_revision + pathType: list get: description: Retrieve a list of all Flows revisions. parameters: @@ -1228,34 +1423,56 @@ paths: items: $ref: '#/components/schemas/studio.v2.flow.flow_revision' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + previous_page_url: null + next_page_url: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0 + page: 0 + first_page_url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions?PageSize=50&Page=0 + page_size: 50 + key: revisions + revisions: + - sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Test Flow + status: published + revision: 1 + definition: null + commit_message: null + valid: null + errors: null + date_created: '2017-11-06T12:00:00Z' + date_updated: '2017-11-06T12:00:00Z' + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1 description: OK security: - accountSid_authToken: [] operationId: ListFlowRevision - x-maturity: - - GA /v2/Flows/{Sid}/Revisions/{Revision}: servers: - url: https://studio.twilio.com @@ -1266,9 +1483,9 @@ paths: - friendly_name - status - revision - pathType: instance parent: /Flows/{Sid} className: flow_revision + pathType: instance get: description: Retrieve a specific Flow revision. parameters: @@ -1293,12 +1510,26 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.flow_revision' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + definition: + initial_state: Trigger + friendly_name: Test Flow + status: published + revision: 1 + commit_message: null + valid: true + errors: [] + date_created: '2017-11-06T12:00:00Z' + date_updated: null + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions/1 description: OK security: - accountSid_authToken: [] operationId: FetchFlowRevision - x-maturity: - - GA /v2/Flows/Validate: servers: - url: https://studio.twilio.com @@ -1306,8 +1537,8 @@ paths: x-twilio: defaultOutputProperties: - valid - pathType: list mountName: flow_validate + pathType: list post: description: Validate flow JSON definition responses: @@ -1316,12 +1547,14 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow_validate' + examples: + update: + value: + valid: true description: OK security: - accountSid_authToken: [] operationId: UpdateFlowValidate - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1345,6 +1578,12 @@ paths: - FriendlyName - Status - Definition + examples: + update: + value: + FriendlyName: Test Flow + Status: published + Definition: '{"initial_state": "Trigger"}' /v2/Flows/{Sid}/TestUsers: servers: - url: https://studio.twilio.com @@ -1352,9 +1591,9 @@ paths: x-twilio: defaultOutputProperties: - test_users - pathType: instance parent: /Flows/{Sid} className: flow_test_user + pathType: instance get: description: Fetch flow test users parameters: @@ -1373,12 +1612,18 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.test_user' + examples: + fetch: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + test_users: + - user1 + - user2 + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers description: OK security: - accountSid_authToken: [] operationId: FetchTestUser - x-maturity: - - GA post: description: Update flow test users parameters: @@ -1397,12 +1642,18 @@ paths: application/json: schema: $ref: '#/components/schemas/studio.v2.flow.test_user' + examples: + update: + value: + sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + test_users: + - user1 + - user2 + url: https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers description: OK security: - accountSid_authToken: [] operationId: UpdateTestUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1418,8 +1669,11 @@ paths: of the flow. required: - TestUsers + examples: + update: + value: + TestUsers: + - user1 + - user2 servers: - url: https://studio.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 068545ac..108582a8 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: supersim.v1.sim.billing_period: type: object @@ -843,10 +847,6 @@ components: type: string enum: - time - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Supersim description: This is the public Twilio REST API. @@ -858,7 +858,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Sims/{SimSid}/BillingPeriods: @@ -872,8 +872,8 @@ paths: - start_time - end_time - period_type - pathType: list parent: /Sims/{Sid} + pathType: list get: description: Retrieve a list of Billing Periods for a Super SIM. parameters: @@ -915,34 +915,82 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sim.billing_period' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + billing_periods: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + next_page_url: null + key: billing_periods + readFullActivePeriod: + value: + billing_periods: + - sid: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period_type: active + start_time: '2021-06-09T13:18:15Z' + end_time: '2021-07-09T13:18:15Z' + date_created: '2021-06-09T13:18:16Z' + date_updated: '2021-06-09T13:18:16Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + next_page_url: null + key: billing_periods + readFullReadyPeriod: + value: + billing_periods: + - sid: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period_type: ready + start_time: '2021-06-09T13:18:15Z' + end_time: '2021-07-09T13:18:15Z' + date_created: '2021-06-09T13:18:16Z' + date_updated: '2021-06-09T13:18:16Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 + next_page_url: null + key: billing_periods description: OK security: - accountSid_authToken: [] operationId: ListBillingPeriod - x-maturity: - - GA /v1/ESimProfiles: servers: - url: https://supersim.twilio.com @@ -951,8 +999,8 @@ paths: defaultOutputProperties: - sid - status - pathType: list mountName: esim_profiles + pathType: list post: description: Order an eSIM Profile. responses: @@ -961,12 +1009,59 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.esim_profile' + examples: + createDefaultSmdp: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: null + sim_sid: null + status: new + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: null + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createActivationCode: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: null + sim_sid: null + status: new + eid: null + smdp_plus_address: null + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithCallback: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: null + sim_sid: null + status: reserving + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: null + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateEsimProfile - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1003,6 +1098,18 @@ paths: Eid: type: string description: Identifier of the eUICC that will claim the eSIM Profile. + examples: + createDefaultSmdp: + value: + Eid: 89049032005008882600033489aaaaaa + createActivationCode: + value: + GenerateMatchingId: true + createWithCallback: + value: + Eid: 89049032005008882600033489aaaaaa + CallbackUrl: http://callback.twilio.com + CallbackMethod: POST get: description: Retrieve a list of eSIM Profiles. parameters: @@ -1011,6 +1118,9 @@ paths: description: List the eSIM Profiles that have been associated with an EId. schema: type: string + examples: + readByEid: + value: 89049032005008882600033489aaaaaa - name: SimSid in: query description: Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/wireless/api/sim-resource) @@ -1018,12 +1128,18 @@ paths: 1 or 0 records. schema: type: string + examples: + readBySimSid: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: List the eSIM Profiles that are in a given status. schema: type: string $ref: '#/components/schemas/esim_profile_enum_status' + examples: + readByStatus: + value: downloaded - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1056,34 +1172,133 @@ paths: items: $ref: '#/components/schemas/supersim.v1.esim_profile' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0 + readByEid: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0 + readBySimSid: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readByStatus: + value: + esim_profiles: + - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: downloaded + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0 + key: esim_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEsimProfile - x-maturity: - - Beta /v1/ESimProfiles/{Sid}: servers: - url: https://supersim.twilio.com @@ -1092,8 +1307,8 @@ paths: defaultOutputProperties: - sid - status - pathType: instance mountName: esim_profiles + pathType: instance get: description: Fetch an eSIM Profile. parameters: @@ -1109,12 +1324,43 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.esim_profile' + examples: + fetchDefaultSmdp: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: 89049032005008882600033489aaaaaa + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: null + activation_code: null + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchActivationCode: + value: + sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: 8988307aaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: available + eid: null + smdp_plus_address: sm-dp-plus.twilio.com + matching_id: AAAAA-BBBBB-CCCCC-DDDDD-EEEEE + activation_code: 1$SM-DP-PLUS.TWILIO.COM$AAAAA-BBBBB-CCCCC-DDDDD-EEEEE + error_code: null + error_message: null + date_created: '2020-09-01T20:00:00Z' + date_updated: '2020-09-01T20:00:00Z' + url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEsimProfile - x-maturity: - - Beta /v1/Fleets: servers: - url: https://supersim.twilio.com @@ -1134,12 +1380,28 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 500 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: GET + sms_commands_url: https://google.com + ip_commands_method: GET + ip_commands_url: https://google.com + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateFleet - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1214,6 +1476,18 @@ paths: Defaults to `POST`. required: - NetworkAccessProfile + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 500 + SmsCommandsEnabled: true + SmsCommandsMethod: GET + SmsCommandsUrl: https://google.com + IpCommandsMethod: GET + IpCommandsUrl: https://google.com + NetworkAccessProfile: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Fleets from your account. parameters: @@ -1223,6 +1497,11 @@ paths: which cellular networks the Fleet's SIMs can connect to. schema: type: string + examples: + readEmpty: + value: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1255,34 +1534,70 @@ paths: items: $ref: '#/components/schemas/supersim.v1.fleet' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + fleets: [] + meta: + first_page_url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: fleets + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + fleets: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: Pilot Fleet + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-10-15T20:00:00Z' + date_updated: '2019-10-15T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: POST + sms_commands_url: null + ip_commands_method: POST + ip_commands_url: null + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListFleet - x-maturity: - - Beta /v1/Fleets/{Sid}: servers: - url: https://supersim.twilio.com @@ -1309,12 +1624,28 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: POST + sms_commands_url: null + ip_commands_method: POST + ip_commands_url: null + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchFleet - x-maturity: - - Beta post: description: Updates the given properties of a Super SIM Fleet instance from your account. @@ -1331,12 +1662,28 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' + examples: + updateUniqueNameAndDataLimit: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: GPS Trackers Fleet 5GB + data_enabled: true + data_limit: 5000 + data_metering: payg + date_created: '2019-10-15T20:00:00Z' + date_updated: '2019-10-15T20:00:00Z' + sms_commands_enabled: true + sms_commands_method: POST + sms_commands_url: null + ip_commands_method: POST + ip_commands_url: null + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateFleet - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1400,6 +1747,12 @@ paths: in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000). + examples: + updateUniqueNameAndDataLimit: + value: + UniqueName: GPS Trackers Fleet 5GB + NetworkAccessProfile: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DataLimit: 5000 /v1/IpCommands: servers: - url: https://supersim.twilio.com @@ -1418,12 +1771,41 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.ip_command' + examples: + createFull: + value: + sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: queued + direction: to_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createMinimal: + value: + sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: queued + direction: to_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateIpCommand - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1470,6 +1852,20 @@ paths: - Sim - Payload - DevicePort + examples: + createFull: + value: + Sim: sim + Payload: 'checkin: firmware update' + DevicePort: 100 + PayloadType: text + CallbackUrl: http://www.example.com + CallbackMethod: GET + createMinimal: + value: + Sim: sim + Payload: 'checkin: firmware update' + DevicePort: 100 get: description: Retrieve a list of IP Commands from your account. parameters: @@ -1479,6 +1875,11 @@ paths: sent to or from. schema: type: string + examples: + readEmpty: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: SimIccid in: query description: The ICCID of the Sim resource that IP Command was sent to or @@ -1493,6 +1894,11 @@ paths: schema: type: string $ref: '#/components/schemas/ip_command_enum_status' + examples: + readEmpty: + value: received + readFull: + value: received - name: Direction in: query description: The direction of the IP Command. Can be `to_sim` or `from_sim`. @@ -1533,34 +1939,68 @@ paths: items: $ref: '#/components/schemas/supersim.v1.ip_command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + ip_commands: [] + meta: + first_page_url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: ip_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: ip_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + ip_commands: + - sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: received + direction: from_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListIpCommand - x-maturity: - - Beta /v1/IpCommands/{Sid}: servers: - url: https://supersim.twilio.com @@ -1589,12 +2029,26 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.ip_command' + examples: + fetch: + value: + sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_iccid: '89883070000123456789' + status: queued + direction: to_sim + device_ip: 100.64.0.123 + device_port: 100 + payload_type: text + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchIpCommand - x-maturity: - - Beta /v1/Networks/{Sid}: servers: - url: https://supersim.twilio.com @@ -1621,12 +2075,20 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network' + examples: + fetch: + value: + friendly_name: AT&T + iso_country: US + identifiers: + - mcc: '310' + mnc: '410' + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchNetwork - x-maturity: - - Beta /v1/Networks: servers: - url: https://supersim.twilio.com @@ -1644,18 +2106,27 @@ paths: of the Network resources to read. schema: type: string + examples: + readWithFilters: + value: US - name: Mcc in: query description: The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read. schema: type: string + examples: + readWithFilters: + value: '310' - name: Mnc in: query description: The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read. schema: type: string + examples: + readWithFilters: + value: '410' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1688,46 +2159,81 @@ paths: items: $ref: '#/components/schemas/supersim.v1.network' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + read: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0 + key: networks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0 + networks: + - friendly_name: AT&T + iso_country: US + identifiers: + - mcc: '310' + mnc: '410' + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readWithFilters: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0 + key: networks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0 + networks: + - friendly_name: AT&T + iso_country: US + identifiers: + - mcc: '310' + mnc: '410' + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListNetwork - x-maturity: - - Beta /v1/NetworkAccessProfiles: servers: - url: https://supersim.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - fleets_count - pathType: list dependentProperties: network_access_profile_network: '{network_access_profile_sid: sid}' + pathType: list post: description: Create a new Network Access Profile responses: @@ -1736,12 +2242,31 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' + examples: + createMinimal: + value: + unique_name: null + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks + createWithNameAndNetworks: + value: + unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: Created security: - accountSid_authToken: [] operationId: CreateNetworkAccessProfile - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1760,6 +2285,15 @@ paths: type: string description: List of Network SIDs that this Network Access Profile will allow connections to. + examples: + createMinimal: + value: {} + createWithNameAndNetworks: + value: + UniqueName: My Network Access Profile + Networks: + - HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab get: description: Retrieve a list of Network Access Profiles from your account. parameters: @@ -1795,46 +2329,75 @@ paths: items: $ref: '#/components/schemas/supersim.v1.network_access_profile' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + network_access_profiles: [] + meta: + first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + key: network_access_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + key: network_access_profiles + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 + network_access_profiles: + - unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: OK security: - accountSid_authToken: [] operationId: ListNetworkAccessProfile - x-maturity: - - Beta /v1/NetworkAccessProfiles/{Sid}: servers: - url: https://supersim.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - fleets_count - pathType: instance dependentProperties: network_access_profile_network: '{network_access_profile_sid: sid}' + pathType: instance get: description: Fetch a Network Access Profile instance from your account. parameters: @@ -1850,12 +2413,21 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' + examples: + fetch: + value: + unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: OK security: - accountSid_authToken: [] operationId: FetchNetworkAccessProfile - x-maturity: - - Beta post: description: Updates the given properties of a Network Access Profile in your account. @@ -1872,12 +2444,21 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' + examples: + updateUniqueName: + value: + unique_name: My Network Access Profile + sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-05-01T20:00:00Z' + date_updated: '2020-05-01T20:00:00Z' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks description: OK security: - accountSid_authToken: [] operationId: UpdateNetworkAccessProfile - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1888,6 +2469,10 @@ paths: UniqueName: type: string description: The new unique name of the Network Access Profile. + examples: + updateUniqueName: + value: + UniqueName: My Network Access Profile /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks: servers: - url: https://supersim.twilio.com @@ -1896,9 +2481,9 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: list parent: /NetworkAccessProfiles/{Sid} className: network_access_profile_network + pathType: list get: description: Retrieve a list of Network Access Profile resource's Network resource. parameters: @@ -1941,34 +2526,52 @@ paths: items: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0 + key: networks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0 + networks: + - sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: AT&T + iso_country: us + identifiers: + - mcc: '310' + mnc: '410' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListNetworkAccessProfileNetwork - x-maturity: - - Beta post: description: Add a Network resource to the Network Access Profile resource. parameters: @@ -1985,12 +2588,21 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' + examples: + create: + value: + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: AT&T + iso_country: us + identifiers: + - mcc: '310' + mnc: '410' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateNetworkAccessProfileNetwork - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2007,6 +2619,10 @@ paths: Network Access Profile resource. required: - Network + examples: + create: + value: + Network: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}: servers: - url: https://supersim.twilio.com @@ -2015,9 +2631,9 @@ paths: x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /NetworkAccessProfiles/{Sid} className: network_access_profile_network + pathType: instance delete: description: Remove a Network resource from the Network Access Profile resource's. parameters: @@ -2047,8 +2663,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteNetworkAccessProfileNetwork - x-maturity: - - Beta get: description: Fetch a Network Access Profile resource's Network resource. parameters: @@ -2074,16 +2688,25 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' + examples: + fetch: + value: + sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: AT&T + iso_country: us + identifiers: + - mcc: '310' + mnc: '410' + url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchNetworkAccessProfileNetwork - x-maturity: - - Beta /v1/SettingsUpdates: servers: - url: https://supersim.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2099,6 +2722,11 @@ paths: description: Filter the Settings Updates by a Super SIM's SID or UniqueName. schema: type: string + examples: + readSimOnly: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: Filter the Settings Updates by status. Can be `scheduled`, `in-progress`, @@ -2106,6 +2734,11 @@ paths: schema: type: string $ref: '#/components/schemas/settings_update_enum_status' + examples: + readStatusOnly: + value: scheduled + readFull: + value: scheduled - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2138,34 +2771,110 @@ paths: items: $ref: '#/components/schemas/supersim.v1.settings_update' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + settings_updates: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0 + next_page_url: null + key: settings_updates + readSimOnly: + value: + settings_updates: + - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: successful + packages: + - name: base-settings + version: 1.0.0 + more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings + date_completed: '2015-07-30T20:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: settings_updates + readStatusOnly: + value: + settings_updates: + - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + packages: + - name: base-settings + version: 1.0.0 + more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings + date_completed: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0 + next_page_url: null + key: settings_updates + readFull: + value: + settings_updates: + - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: scheduled + packages: + - name: base-settings + version: 1.0.0 + more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings + date_completed: null + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: settings_updates description: OK security: - accountSid_authToken: [] operationId: ListSettingsUpdate - x-maturity: - - Beta /v1/Sims: servers: - url: https://supersim.twilio.com @@ -2175,10 +2884,10 @@ paths: - sid - unique_name - status - pathType: list dependentProperties: billing_period: '{sim_sid: sid}' sim_ip_address: '{sim_sid: sid}' + pathType: list post: description: Register a Super SIM to your Account responses: @@ -2187,12 +2896,25 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + create: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: '' + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: Created security: - accountSid_authToken: [] operationId: CreateSim - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2211,6 +2933,11 @@ paths: required: - Iccid - RegistrationCode + examples: + create: + value: + Iccid: '89883070000123456789' + RegistrationCode: H3LL0W0RLD get: description: Retrieve a list of Super SIMs from your account. parameters: @@ -2221,12 +2948,26 @@ paths: schema: type: string $ref: '#/components/schemas/sim_enum_status' + examples: + readEmpty: + value: new + readFullByFleetSid: + value: new + readFullByFleetName: + value: new - name: Fleet in: query description: The SID or unique name of the Fleet to which a list of Sims are assigned. schema: type: string + examples: + readEmpty: + value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFullByFleetSid: + value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFullByFleetName: + value: MyFleet - name: Iccid in: query description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) @@ -2234,6 +2975,9 @@ paths: will always return a list containing zero or one SIMs. schema: type: string + examples: + readByIccid: + value: '89883070000123456789' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2266,34 +3010,113 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sim' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sims: [] + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFullByFleetSid: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + sims: + - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + readFullByFleetName: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0 + sims: + - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + readByIccid: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0 + sims: + - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: OK security: - accountSid_authToken: [] operationId: ListSim - x-maturity: - - Beta /v1/Sims/{Sid}: servers: - url: https://supersim.twilio.com @@ -2303,10 +3126,10 @@ paths: - sid - unique_name - status - pathType: instance dependentProperties: billing_period: '{sim_sid: sid}' sim_ip_address: '{sim_sid: sid}' + pathType: instance get: description: Fetch a Super SIM instance from your account. parameters: @@ -2322,12 +3145,25 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + fetch: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: My SIM + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: OK security: - accountSid_authToken: [] operationId: FetchSim - x-maturity: - - Beta post: description: Updates the given properties of a Super SIM instance from your account. @@ -2344,18 +3180,88 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + updateUniqueName: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: MySIM + status: new + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + updateFleetWithSid: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: null + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + updateFleetWithUniqueName: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: null + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses + transferSimToAnotherAccount: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + unique_name: null + status: new + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: OK '202': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' + examples: + updateStatus: + value: + sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: null + status: scheduled + fleet_sid: null + iccid: '89883070000123456789' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods + sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses description: Accepted security: - accountSid_authToken: [] operationId: UpdateSim - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2401,6 +3307,29 @@ paths: belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new. + examples: + updateUniqueName: + value: + UniqueName: MySIM + updateStatus: + value: + Status: active + CallbackUrl: http://127.0.0.1:9876/path + CallbackMethod: POST + updateFleetWithSid: + value: + Fleet: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + CallbackUrl: http://127.0.0.1:9876/path + CallbackMethod: POST + updateFleetWithUniqueName: + value: + Fleet: My Fleet + CallbackUrl: http://127.0.0.1:9876/path + CallbackMethod: POST + transferSimToAnotherAccount: + value: + AccountSid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + Fleet: My Fleet /v1/Sims/{SimSid}/IpAddresses: servers: - url: https://supersim.twilio.com @@ -2409,9 +3338,9 @@ paths: defaultOutputProperties: - ip_address - ip_address_version - pathType: list parent: /Sims/{Sid} mountName: sim_ip_addresses + pathType: list get: description: Retrieve a list of IP Addresses for the given Super SIM. parameters: @@ -2453,34 +3382,57 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sim.sim_ip_address' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + key: ip_addresses + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + ip_addresses: [] + readNonEmpty: + value: + meta: + key: ip_addresses + first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 + ip_addresses: + - ip_address: 8.8.8.8 + ip_address_version: IPv4 description: OK security: - accountSid_authToken: [] operationId: ListSimIpAddress - x-maturity: - - Beta /v1/SmsCommands: servers: - url: https://supersim.twilio.com @@ -2499,12 +3451,33 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sms_command' + examples: + createCommandMinimal: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: 'checkin: firmware update' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + direction: to_sim + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCommandFull: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: 'Report location: (52.520008, 13.404954)' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + direction: to_sim + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSmsCommand - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -2539,6 +3512,17 @@ paths: required: - Sim - Payload + examples: + createCommandMinimal: + value: + Payload: 'checkin: firmware update' + Sim: SimSidOrUniqueName + createCommandFull: + value: + Payload: 'Report location: (52.520008, 13.404954)' + Sim: SimSidOrUniqueName + CallbackMethod: POST + CallbackUrl: http://blahblah.com/go get: description: Retrieve a list of SMS Commands from your account. parameters: @@ -2548,6 +3532,11 @@ paths: sent to or from. schema: type: string + examples: + readEmpty: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readFull: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: 'The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, @@ -2556,6 +3545,11 @@ paths: schema: type: string $ref: '#/components/schemas/sms_command_enum_status' + examples: + readEmpty: + value: received + readFull: + value: received - name: Direction in: query description: The direction of the SMS Command. Can be `to_sim` or `from_sim`. @@ -2596,34 +3590,64 @@ paths: items: $ref: '#/components/schemas/supersim.v1.sms_command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sms_commands: [] + meta: + first_page_url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sms_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readFull: + value: + meta: + first_page_url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: sms_commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + sms_commands: + - sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: content of the command + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: received + direction: from_sim + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListSmsCommand - x-maturity: - - Beta /v1/SmsCommands/{Sid}: servers: - url: https://supersim.twilio.com @@ -2652,12 +3676,22 @@ paths: application/json: schema: $ref: '#/components/schemas/supersim.v1.sms_command' + examples: + fetch: + value: + sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + payload: content of the command + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + direction: to_sim + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSmsCommand - x-maturity: - - Beta /v1/UsageRecords: servers: - url: https://supersim.twilio.com @@ -2676,6 +3710,9 @@ paths: representing usage incurred by this Super SIM. schema: type: string + examples: + readDaySimFilter: + value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Fleet in: query description: SID or unique name of a Fleet resource. Only show UsageRecords @@ -2683,6 +3720,9 @@ paths: time the usage occurred. schema: type: string + examples: + readDayFleetFilter: + value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Network in: query description: SID of a Network resource. Only show UsageRecords representing @@ -2692,6 +3732,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ + examples: + readDayNetworkFilter: + value: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: IsoCountry in: query description: Alpha-2 ISO Country Code. Only show UsageRecords representing @@ -2699,6 +3742,11 @@ paths: schema: type: string format: iso-country-code + examples: + readDayCountryFilter: + value: FR + readDayGroupBySimAndFilterByCountry: + value: FR - name: Group in: query description: 'Dimension over which to aggregate usage records. Can be: `sim`, @@ -2708,6 +3756,17 @@ paths: schema: type: string $ref: '#/components/schemas/usage_record_enum_group' + examples: + readDayGroupBySim: + value: sim + readDayGroupByFleet: + value: fleet + readDayGroupByNetwork: + value: network + readDayGroupByIsoCountry: + value: isoCountry + readDayGroupBySimAndFilterByCountry: + value: sim - name: Granularity in: query description: 'Time-based grouping that UsageRecords should be aggregated by. @@ -2716,6 +3775,19 @@ paths: schema: type: string $ref: '#/components/schemas/usage_record_enum_granularity' + examples: + readAllDay: + value: day + readAllHour: + value: hour + readDaySimFilter: + value: day + readDayNetworkFilter: + value: day + readDayCountryFilter: + value: day + readDayFleetFilter: + value: day - name: StartTime in: query description: Only include usage that occurred at or after this time, specified @@ -2764,39 +3836,487 @@ paths: items: $ref: '#/components/schemas/supersim.v1.usage_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + usage_records: + - period: + start_time: '2015-05-01T20:00:00Z' + end_time: '2015-06-01T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 + readAllDay: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0 + readAllHour: + value: + usage_records: + - period: + start_time: '2019-05-01T01:00:00Z' + end_time: '2019-05-01T02:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-01T00:00:00Z' + end_time: '2019-05-01T01:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0 + readDaySimFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + readDayNetworkFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + readDayCountryFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: FR + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: FR + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0 + readDayFleetFilter: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_sid: null + iso_country: null + - period: + start_time: '2019-05-02T00:00:00Z' + end_time: '2019-05-03T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 + readDayGroupBySim: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: null + network_sid: null + iso_country: null + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0 + readDayGroupByFleet: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + network_sid: null + iso_country: null + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: HFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0 + readDayGroupByNetwork: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iso_country: null + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: HWbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0 + readDayGroupByIsoCountry: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: FR + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: US + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0 + readDayGroupBySimAndFilterByCountry: + value: + usage_records: + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: null + network_sid: null + iso_country: FR + - period: + start_time: '2019-05-03T00:00:00Z' + end_time: '2019-05-04T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 150000 + data_download: 150000 + data_total: 300000 + data_total_billed: '0.03' + billed_unit: USD + sim_sid: HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + fleet_sid: null + network_sid: null + iso_country: FR + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0 + readAllNoBilling: + value: + usage_records: + - period: + start_time: '2015-05-01T20:00:00Z' + end_time: '2015-06-01T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data_upload: 1000 + data_download: 1000 + data_total: 2000 + data_total_billed: '0' + billed_unit: null + sim_sid: null + fleet_sid: null + network_sid: null + iso_country: null + meta: + first_page_url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord - x-maturity: - - Beta servers: - url: https://supersim.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index bb704224..5de61b30 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: sync.v1.service.document: type: object @@ -705,10 +709,6 @@ components: description: The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Sync description: This is the public Twilio REST API. @@ -720,7 +720,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Documents/{Sid}: @@ -732,10 +732,10 @@ paths: - sid - unique_name - revision - pathType: instance dependentProperties: document_permission: '{service_sid: service_sid, document_sid: sid}' parent: /Services/{Sid} + pathType: instance get: description: '' parameters: @@ -759,12 +759,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] operationId: FetchDocument - x-maturity: - - GA delete: description: '' parameters: @@ -788,8 +802,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDocument - x-maturity: - - GA post: description: '' parameters: @@ -818,12 +830,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] operationId: UpdateDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -838,6 +864,12 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live). + examples: + update: + value: + Data: '{}' + UniqueName: unique_name + Ttl: 3600 /v1/Services/{ServiceSid}/Documents: servers: - url: https://sync.twilio.com @@ -847,10 +879,10 @@ paths: - sid - unique_name - revision - pathType: list dependentProperties: document_permission: '{service_sid: service_sid, document_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: '' parameters: @@ -867,12 +899,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: Created security: - accountSid_authToken: [] operationId: CreateDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -892,6 +938,12 @@ paths: description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live). + examples: + create: + value: + Data: '{}' + UniqueName: unique_name + Ttl: 3600 get: description: '' parameters: @@ -934,34 +986,68 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + documents: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + readFull: + value: + documents: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDocument - x-maturity: - - GA /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com @@ -972,9 +1058,9 @@ paths: - read - write - manage - pathType: instance parent: /Services/{ServiceSid}/Documents/{Sid} mountName: document_permissions + pathType: instance get: description: Fetch a specific Sync Document Permission. parameters: @@ -1005,12 +1091,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document.document_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: FetchDocumentPermission - x-maturity: - - GA delete: description: Delete a specific Sync Document Permission. parameters: @@ -1041,8 +1136,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteDocumentPermission - x-maturity: - - GA post: description: Update an identity's access to a specific Sync Document. parameters: @@ -1073,12 +1166,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document.document_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: UpdateDocumentPermission - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1102,6 +1204,12 @@ paths: - Read - Write - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://sync.twilio.com @@ -1112,9 +1220,9 @@ paths: - read - write - manage - pathType: list parent: /Services/{ServiceSid}/Documents/{Sid} mountName: document_permissions + pathType: list get: description: Retrieve a list of all Permissions applying to a Sync Document. parameters: @@ -1164,34 +1272,63 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.document.document_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDocumentPermission - x-maturity: - - GA /v1/Services/{Sid}: servers: - url: https://sync.twilio.com @@ -1201,12 +1338,12 @@ paths: - sid - unique_name - friendly_name - pathType: instance dependentProperties: document: '{service_sid: sid}' sync_list: '{service_sid: sid}' sync_map: '{service_sid: sid}' sync_stream: '{service_sid: sid}' + pathType: instance get: description: '' parameters: @@ -1222,12 +1359,31 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: false + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: '' parameters: @@ -1243,8 +1399,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: '' parameters: @@ -1260,12 +1414,31 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: true + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1310,6 +1483,12 @@ paths: description: Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`. + examples: + update: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true /v1/Services: servers: - url: https://sync.twilio.com @@ -1319,12 +1498,12 @@ paths: - sid - unique_name - friendly_name - pathType: list dependentProperties: document: '{service_sid: sid}' sync_list: '{service_sid: sid}' sync_map: '{service_sid: sid}' sync_stream: '{service_sid: sid}' + pathType: list post: description: '' responses: @@ -1333,12 +1512,31 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: true + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1383,6 +1581,13 @@ paths: description: Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`. + examples: + create: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + ReachabilityDebouncingWindow: 5000 get: description: '' parameters: @@ -1418,44 +1623,83 @@ paths: items: $ref: '#/components/schemas/sync.v1.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + services: [] + readFull: + value: + meta: + first_page_url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + key: services + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + streams: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + webhooks_from_rest_enabled: false + reachability_webhooks_enabled: false + acl_enabled: false + reachability_debouncing_enabled: false + reachability_debouncing_window: 5000 description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /Services/{ServiceSid}/Streams/{Sid} mountName: stream_messages + pathType: list post: description: Create a new Stream Message. parameters: @@ -1479,12 +1723,15 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream.stream_message' + examples: + create: + value: + sid: TZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + data: {} description: Created security: - accountSid_authToken: [] operationId: CreateStreamMessage - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1498,6 +1745,10 @@ paths: in length. required: - Data + examples: + create: + value: + Data: '{}' /v1/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://sync.twilio.com @@ -1507,12 +1758,12 @@ paths: - sid - unique_name - revision - pathType: instance dependentProperties: sync_list_item: '{service_sid: service_sid, list_sid: sid}' sync_list_permission: '{service_sid: service_sid, list_sid: sid}' parent: /Services/{Sid} mountName: sync_lists + pathType: instance get: description: '' parameters: @@ -1536,12 +1787,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSyncList - x-maturity: - - GA delete: description: '' parameters: @@ -1565,8 +1830,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncList - x-maturity: - - GA post: description: '' parameters: @@ -1590,12 +1853,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSyncList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1611,6 +1888,10 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. + examples: + update: + value: + Ttl: 3600 /v1/Services/{ServiceSid}/Lists: servers: - url: https://sync.twilio.com @@ -1620,12 +1901,12 @@ paths: - sid - unique_name - revision - pathType: list dependentProperties: sync_list_item: '{service_sid: service_sid, list_sid: sid}' sync_list_permission: '{service_sid: service_sid, list_sid: sid}' parent: /Services/{Sid} mountName: sync_lists + pathType: list post: description: '' parameters: @@ -1642,12 +1923,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSyncList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1670,6 +1965,11 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. + examples: + create: + value: + UniqueName: unique_name + Ttl: 3600 get: description: '' parameters: @@ -1712,34 +2012,68 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + lists: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + readFull: + value: + lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncList - x-maturity: - - GA /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: servers: - url: https://sync.twilio.com @@ -1749,9 +2083,9 @@ paths: - index - revision - created_by - pathType: instance parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_items + pathType: instance get: description: '' parameters: @@ -1781,12 +2115,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] operationId: FetchSyncListItem - x-maturity: - - GA delete: description: '' parameters: @@ -1824,8 +2170,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncListItem - x-maturity: - - GA post: description: '' parameters: @@ -1863,12 +2207,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] operationId: UpdateSyncListItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1893,6 +2249,11 @@ paths: before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request. + examples: + update: + value: + Data: '{}' + Ttl: 3600 /v1/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://sync.twilio.com @@ -1902,9 +2263,9 @@ paths: - index - revision - created_by - pathType: list parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_items + pathType: list post: description: '' parameters: @@ -1928,12 +2289,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: Created security: - accountSid_authToken: [] operationId: CreateSyncListItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1959,6 +2332,11 @@ paths: and is deleted. required: - Data + examples: + create: + value: + Data: '{}' + Ttl: 3600 get: description: '' parameters: @@ -1983,12 +2361,22 @@ paths: schema: type: string $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc - name: From in: query description: The `index` of the first Sync List Item resource to read. See also `bounds`. schema: type: string + examples: + readEmpty: + value: from + readFull: + value: from - name: Bounds in: query description: 'Whether to include the List Item referenced by the `from` parameter. @@ -1997,6 +2385,11 @@ paths: schema: type: string $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2029,34 +2422,66 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncListItem - x-maturity: - - GA /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com @@ -2067,9 +2492,9 @@ paths: - read - write - manage - pathType: instance parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_permissions + pathType: instance get: description: Fetch a specific Sync List Permission. parameters: @@ -2100,12 +2525,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: FetchSyncListPermission - x-maturity: - - GA delete: description: Delete a specific Sync List Permission. parameters: @@ -2136,8 +2570,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncListPermission - x-maturity: - - GA post: description: Update an identity's access to a specific Sync List. parameters: @@ -2168,12 +2600,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: UpdateSyncListPermission - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2197,6 +2638,12 @@ paths: - Read - Write - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://sync.twilio.com @@ -2207,9 +2654,9 @@ paths: - read - write - manage - pathType: list parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_permissions + pathType: list get: description: Retrieve a list of all Permissions applying to a Sync List. parameters: @@ -2259,34 +2706,63 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncListPermission - x-maturity: - - GA /v1/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://sync.twilio.com @@ -2296,12 +2772,12 @@ paths: - sid - unique_name - revision - pathType: instance dependentProperties: sync_map_item: '{service_sid: service_sid, map_sid: sid}' sync_map_permission: '{service_sid: service_sid, map_sid: sid}' parent: /Services/{Sid} mountName: sync_maps + pathType: instance get: description: '' parameters: @@ -2325,12 +2801,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSyncMap - x-maturity: - - GA delete: description: '' parameters: @@ -2354,8 +2844,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncMap - x-maturity: - - GA post: description: '' parameters: @@ -2379,12 +2867,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMap - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2400,6 +2902,10 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. + examples: + update: + value: + Ttl: 3600 /v1/Services/{ServiceSid}/Maps: servers: - url: https://sync.twilio.com @@ -2409,12 +2915,12 @@ paths: - sid - unique_name - revision - pathType: list dependentProperties: sync_map_item: '{service_sid: service_sid, map_sid: sid}' sync_map_permission: '{service_sid: service_sid, map_sid: sid}' parent: /Services/{Sid} mountName: sync_maps + pathType: list post: description: '' parameters: @@ -2431,12 +2937,26 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSyncMap - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2457,6 +2977,11 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. + examples: + create: + value: + UniqueName: unique_name + Ttl: 3600 get: description: '' parameters: @@ -2499,34 +3024,68 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_map' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + maps: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + readFull: + value: + maps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncMap - x-maturity: - - GA /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: servers: - url: https://sync.twilio.com @@ -2536,9 +3095,9 @@ paths: - key - revision - created_by - pathType: instance parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_items + pathType: instance get: description: '' parameters: @@ -2568,12 +3127,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] operationId: FetchSyncMapItem - x-maturity: - - GA delete: description: '' parameters: @@ -2611,8 +3182,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncMapItem - x-maturity: - - GA post: description: '' parameters: @@ -2650,12 +3219,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMapItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2680,6 +3261,11 @@ paths: before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request. + examples: + update: + value: + Data: '{}' + Ttl: 3600 /v1/Services/{ServiceSid}/Maps/{MapSid}/Items: servers: - url: https://sync.twilio.com @@ -2689,9 +3275,9 @@ paths: - key - revision - created_by - pathType: list parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_items + pathType: list post: description: '' parameters: @@ -2715,12 +3301,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: Created security: - accountSid_authToken: [] operationId: CreateSyncMapItem - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2751,6 +3349,12 @@ paths: required: - Key - Data + examples: + create: + value: + Data: '{}' + Key: key + Ttl: 3600 get: description: '' parameters: @@ -2777,12 +3381,22 @@ paths: schema: type: string $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc - name: From in: query description: The `key` of the first Sync Map Item resource to read. See also `bounds`. schema: type: string + examples: + readEmpty: + value: from + readFull: + value: from - name: Bounds in: query description: 'Whether to include the Map Item referenced by the `from` parameter. @@ -2791,6 +3405,11 @@ paths: schema: type: string $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + examples: + readEmpty: + value: inclusive + readFull: + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2823,47 +3442,79 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + items: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + readFull: + value: + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncMapItem - x-maturity: - - GA /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - identity - read - write - manage - pathType: instance parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_permissions + pathType: instance get: description: Fetch a specific Sync Map Permission. parameters: @@ -2895,12 +3546,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: FetchSyncMapPermission - x-maturity: - - GA delete: description: Delete a specific Sync Map Permission. parameters: @@ -2932,8 +3592,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncMapPermission - x-maturity: - - GA post: description: Update an identity's access to a specific Sync Map. parameters: @@ -2965,12 +3623,21 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMapPermission - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2994,19 +3661,25 @@ paths: - Read - Write - Manage + examples: + update: + value: + Read: 'true' + Write: 'true' + Manage: 'true' /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - identity - read - write - manage - pathType: list parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_permissions + pathType: list get: description: Retrieve a list of all Permissions applying to a Sync Map. parameters: @@ -3057,48 +3730,77 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + permissions: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + readFull: + value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncMapPermission - x-maturity: - - GA /v1/Services/{ServiceSid}/Streams/{Sid}: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - created_by - pathType: instance dependentProperties: stream_message: '{service_sid: service_sid, stream_sid: sid}' parent: /Services/{Sid} mountName: sync_streams + pathType: instance get: description: Fetch a specific Stream. parameters: @@ -3121,12 +3823,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSyncStream - x-maturity: - - GA delete: description: Delete a specific Stream. parameters: @@ -3149,8 +3863,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSyncStream - x-maturity: - - GA post: description: Update a specific Stream. parameters: @@ -3173,12 +3885,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSyncStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3190,20 +3914,24 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). + examples: + update: + value: + Ttl: 3600 /v1/Services/{ServiceSid}/Streams: servers: - url: https://sync.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - unique_name - created_by - pathType: list dependentProperties: stream_message: '{service_sid: service_sid, stream_sid: sid}' parent: /Services/{Sid} mountName: sync_streams + pathType: list post: description: Create a new Stream. parameters: @@ -3220,12 +3948,24 @@ paths: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSyncStream - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3244,6 +3984,11 @@ paths: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). + examples: + create: + value: + UniqueName: unique_name + Ttl: 3600 get: description: Retrieve a list of all Streams in a Service Instance. parameters: @@ -3286,36 +4031,65 @@ paths: items: $ref: '#/components/schemas/sync.v1.service.sync_stream' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + streams: [] + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 + key: streams + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 + readFull: + value: + streams: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_expires: '2015-07-30T21:00:00Z' + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + messages: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 + key: streams + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSyncStream - x-maturity: - - GA servers: - url: https://sync.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index ccf54947..2a2c5977 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: taskrouter.v1.workspace.activity: type: object @@ -452,6 +456,46 @@ components: enum: - FIFO - LIFO + taskrouter.v1.task_queue_bulk_real_time_statistics: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskQueue resource. + workspace_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WS[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Workspace that contains the TaskQueue. + task_queue_data: + nullable: true + description: 'The TaskQueue RealTime Statistics for each requested TaskQueue + SID, represented as a map of TaskQueue SID to the TaskQueue result, each + result contains the following attributes: task_queue_sid: The SID of the + TaskQueue from which these statistics were calculated, total_available_workers: + The total number of Workers available for Tasks in the TaskQueue, total_eligible_workers: + The total number of Workers eligible for Tasks in the TaskQueue, independent + of their Activity state, total_tasks: The total number of Tasks, longest_task_waiting_age: + The age of the longest waiting Task, longest_task_waiting_sid: The SID + of the longest waiting Task, tasks_by_status: The number of Tasks by their + current status, tasks_by_priority: The number of Tasks by priority, activity_statistics: + The number of current Workers by Activity.' + task_queue_response_count: + type: integer + nullable: true + description: The number of TaskQueue statistics received in task_queue_data. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the TaskQueue statistics resource. taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics: type: object properties: @@ -1826,10 +1870,6 @@ components: format: uri nullable: true description: The absolute URL of the Workspace statistics resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Taskrouter description: This is the public Twilio REST API. @@ -1841,20 +1881,20 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -1882,12 +1922,23 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchActivity - x-maturity: - - GA post: description: '' parameters: @@ -1915,12 +1966,23 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateActivity - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1935,6 +1997,10 @@ paths: are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.' + examples: + update: + value: + FriendlyName: friendly_name delete: description: '' parameters: @@ -1962,19 +2028,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteActivity - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Activities: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -1992,6 +2056,11 @@ paths: description: The `friendly_name` of the Activity resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: Available in: query description: Whether return only Activity resources that are available or @@ -2000,6 +2069,11 @@ paths: and return activities that are unavailable. schema: type: string + examples: + readFull: + value: 'true' + readEmpty: + value: 'true' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2032,34 +2106,65 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + activities: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 + key: activities + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 + readEmpty: + value: + activities: [] + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 + key: activities + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities?Available=true&FriendlyName=friendly_name&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListActivity - x-maturity: - - GA post: description: '' parameters: @@ -2078,12 +2183,23 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.activity' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available: true + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + friendly_name: New Activity + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateActivity - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2107,17 +2223,22 @@ paths: is created. required: - FriendlyName + examples: + create: + value: + Available: 'true' + FriendlyName: friendly_name /v1/Workspaces/{WorkspaceSid}/Events/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - description - event_date - pathType: instance parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -2145,23 +2266,50 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.event' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: workspace + actor_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Worker JustinWorker updated to Idle Activity + event_data: + worker_activity_name: Offline + worker_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_attributes: '{}' + worker_name: JustinWorker + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_time_in_previous_activity: '26' + worker_time_in_previous_activity_ms: '26123' + workspace_name: WorkspaceName + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_date: '2015-02-07T00:32:41Z' + event_date_ms: 987654321111 + event_type: worker.activity + resource_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: worker + resource_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: twilio + source_ip_address: 1.2.3.4 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEvent - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Events: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - description - event_date - pathType: list parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -2182,11 +2330,21 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-03T00:00:00Z' + readEmpty: + value: '2008-01-03T00:00:00Z' - name: EventType in: query description: The type of Events to read. Returns only Events of the type specified. schema: type: string + examples: + readFull: + value: reservation.created + readEmpty: + value: reservation.created - name: Minutes in: query description: The period of events to read in minutes. Returns only Events @@ -2203,6 +2361,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WR[0-9a-fA-F]{32}$ + examples: + readFull: + value: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: StartDate in: query description: Only include Events from on or after this date and time, specified @@ -2211,6 +2374,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02T00:00:00Z' + readEmpty: + value: '2008-01-02T00:00:00Z' - name: TaskQueueSid in: query description: The SID of the TaskQueue with the Events to read. Returns only @@ -2220,6 +2388,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ + examples: + readFull: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: TaskSid in: query description: The SID of the Task with the Events to read. Returns only the @@ -2229,6 +2402,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ + examples: + readFull: + value: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: WorkerSid in: query description: The SID of the Worker with the Events to read. Returns only the @@ -2238,6 +2416,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ + examples: + readFull: + value: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: WorkflowSid in: query description: The SID of the Workflow with the Events to read. Returns only @@ -2247,6 +2430,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ + examples: + readFull: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: TaskChannel in: query description: The TaskChannel with the Events to read. Returns only the Events @@ -2293,38 +2481,85 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.event' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + events: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + actor_type: workspace + actor_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Worker JustinWorker updated to Idle Activity + event_data: + worker_activity_name: Offline + worker_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_attributes: '{}' + worker_name: JustinWorker + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_time_in_previous_activity: '26' + worker_time_in_previous_activity_ms: '26123' + workspace_name: WorkspaceName + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_date: '2015-02-07T00:32:41Z' + event_date_ms: 987654321111 + event_type: worker.activity + resource_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + resource_type: worker + resource_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source: twilio + source_ip_address: 1.2.3.4 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + readEmpty: + value: + events: [] + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: events + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListEvent - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2332,10 +2567,10 @@ paths: - assignment_status - priority - reason - pathType: instance dependentProperties: reservation: '{workspace_sid: workspace_sid, task_sid: sid}' parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -2363,12 +2598,38 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "hello"}' + date_created: '2014-05-14T18:50:02Z' + date_updated: '2014-05-15T07:26:06Z' + task_queue_entered_date: '2014-05-14T18:50:02Z' + priority: 0 + reason: Test Reason + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: task-channel + timeout: 60 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_friendly_name: Test Workflow + task_queue_friendly_name: Test Queue + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: FetchTask - x-maturity: - - GA post: description: '' parameters: @@ -2403,12 +2664,38 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "hello"}' + date_created: '2014-05-14T18:50:02Z' + date_updated: '2014-05-15T07:26:06Z' + task_queue_entered_date: '2014-05-14T18:50:02Z' + priority: 0 + reason: Test Reason + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: task-channel + timeout: 60 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_friendly_name: Test Workflow + task_queue_friendly_name: Test Queue + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: UpdateTask - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2442,6 +2729,13 @@ paths: description: When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`. + examples: + update: + value: + AssignmentStatus: pending + Attributes: attributes + Priority: 1 + Reason: reason delete: description: '' parameters: @@ -2476,12 +2770,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTask - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2489,10 +2781,10 @@ paths: - assignment_status - priority - reason - pathType: list dependentProperties: reservation: '{workspace_sid: workspace_sid, task_sid: sid}' parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -2511,6 +2803,13 @@ paths: all Tasks in the Workspace with the specified priority. schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 + readAssignmentStatusMultiple: + value: 1 - name: AssignmentStatus in: query description: 'The `assignment_status` of the Tasks you want to read. Can be: @@ -2520,6 +2819,15 @@ paths: type: array items: type: string + examples: + readFull: + value: pending,reserved + readEmpty: + value: pending + readAssignmentStatusMultiple: + value: + - pending + - reserved - name: WorkflowSid in: query description: The SID of the Workflow with the Tasks to read. Returns the Tasks @@ -2529,12 +2837,26 @@ paths: minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ + examples: + readFull: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readAssignmentStatusMultiple: + value: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: WorkflowName in: query description: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name. schema: type: string + examples: + readFull: + value: workflow_name + readEmpty: + value: workflow_name + readAssignmentStatusMultiple: + value: workflow_name - name: TaskQueueSid in: query description: The SID of the TaskQueue with the Tasks to read. Returns the @@ -2544,12 +2866,26 @@ paths: minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ + examples: + readFull: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readAssignmentStatusMultiple: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: TaskQueueName in: query description: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name. schema: type: string + examples: + readFull: + value: task_queue_name + readEmpty: + value: task_queue_name + readAssignmentStatusMultiple: + value: task_queue_name - name: EvaluateTaskAttributes in: query description: The attributes of the Tasks to read. Returns the Tasks that match @@ -2606,34 +2942,91 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0 + key: tasks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&PageSize=50&Page=0 + tasks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "hello"}' + date_created: '2014-05-14T14:26:54Z' + date_updated: '2014-05-15T16:03:42Z' + task_queue_entered_date: '2014-05-14T14:26:54Z' + priority: 0 + reason: Test Reason + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: task-channel + timeout: 60 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_friendly_name: Test Workflow + task_queue_friendly_name: Test Queue + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + key: tasks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + tasks: [] + readAssignmentStatusMultiple: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + key: tasks + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Priority=1&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&PageSize=50&Page=0 + tasks: [] description: OK security: - accountSid_authToken: [] operationId: ListTask - x-maturity: - - GA post: description: '' parameters: @@ -2652,12 +3045,38 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + age: 25200 + assignment_status: pending + attributes: '{"body": "attributes"}' + date_created: '2014-05-14T18:50:02Z' + date_updated: '2014-05-15T07:26:06Z' + task_queue_entered_date: null + priority: 1 + reason: Test Reason + sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: unique + timeout: 60 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow_friendly_name: Example Workflow + task_queue_friendly_name: Example Task Queue + addons: '{}' + links: + task_queue: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workflow: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: Created security: - accountSid_authToken: [] operationId: CreateTask - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2700,6 +3119,14 @@ paths: when the Task is assigned to a Worker. For example: `{ "task_type": "call", "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }`.' + examples: + create: + value: + Attributes: '{"body": "attributes"}' + Priority: 1 + Timeout: 1 + WorkflowSid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TaskChannel: channel /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}: servers: - url: https://taskrouter.twilio.com @@ -2709,8 +3136,8 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -2735,12 +3162,37 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' + examples: + fetchSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + friendly_name: Default + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchUniqueName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + friendly_name: Default + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: false + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskChannel - x-maturity: - - GA post: description: '' parameters: @@ -2765,12 +3217,37 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' + examples: + updateSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Default + unique_name: default + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateUniqueName: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Default + unique_name: default + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateTaskChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2787,6 +3264,15 @@ paths: description: Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized. + examples: + updateSid: + value: + FriendlyName: Outbound Voice + ChannelOptimizedRouting: true + updateUniqueName: + value: + FriendlyName: Outbound Voice + ChannelOptimizedRouting: true delete: description: '' parameters: @@ -2811,8 +3297,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTaskChannel - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskChannels: servers: - url: https://taskrouter.twilio.com @@ -2822,8 +3306,8 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -2868,34 +3352,66 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + friendly_name: Default + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_optimized_routing: true + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 + readEmpty: + value: + channels: [] + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListTaskChannel - x-maturity: - - GA post: description: '' parameters: @@ -2914,12 +3430,24 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_channel' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Outbound Voice + unique_name: ovoice + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + channel_optimized_routing: true + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTaskChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2943,16 +3471,20 @@ paths: required: - FriendlyName - UniqueName + examples: + create: + value: + FriendlyName: Outbound Voice + UniqueName: ovoice /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - task_order - pathType: instance dependentProperties: task_queue_statistics: '{workspace_sid: workspace_sid, task_queue_sid: sid}' task_queue_real_time_statistics: '{workspace_sid: workspace_sid, task_queue_sid: @@ -2960,6 +3492,7 @@ paths: task_queue_cumulative_statistics: '{workspace_sid: workspace_sid, task_queue_sid: sid}' parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -2987,12 +3520,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_workers: null + task_order: FIFO + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueue - x-maturity: - - GA post: description: '' parameters: @@ -3020,12 +3577,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_workers: null + task_order: FIFO + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateTaskQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3070,6 +3651,15 @@ paths: or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' + examples: + update: + value: + AssignmentActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + MaxReservedWorkers: 1 + ReservationActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TargetWorkers: target_workers + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' parameters: @@ -3097,18 +3687,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTaskQueue - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - task_order - pathType: list dependentProperties: task_queue_statistics: '{workspace_sid: workspace_sid, task_queue_sid: sid}' task_queue_real_time_statistics: '{workspace_sid: workspace_sid, task_queue_sid: @@ -3116,6 +3703,7 @@ paths: task_queue_cumulative_statistics: '{workspace_sid: workspace_sid, task_queue_sid: sid}' parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -3133,12 +3721,22 @@ paths: description: The `friendly_name` of the TaskQueue resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: EvaluateWorkerAttributes in: query description: The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter. schema: type: string + examples: + readFull: + value: evaluate_worker_attributes + readEmpty: + value: evaluate_worker_attributes - name: WorkerSid in: query description: The SID of the Worker with the TaskQueue resources to read. @@ -3184,34 +3782,78 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0 + key: task_queues + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0 + task_queues: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_workers: null + task_order: FIFO + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0 + key: task_queues + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues?EvaluateWorkerAttributes=evaluate_worker_attributes&FriendlyName=friendly_name&PageSize=50&Page=0 + task_queues: [] description: OK security: - accountSid_authToken: [] operationId: ListTaskQueue - x-maturity: - - GA post: description: '' parameters: @@ -3230,12 +3872,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_activity_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + assignment_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-08-04T01:31:41Z' + date_updated: '2015-08-04T01:31:41Z' + friendly_name: 81f96435-3a05-11e5-9f81-98e0d9a1eb73 + max_reserved_workers: 1 + links: + assignment_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + target_workers: null + task_order: FIFO + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTaskQueue - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3283,19 +3949,96 @@ paths: is assigned to them. required: - FriendlyName + examples: + create: + value: + AssignmentActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + MaxReservedWorkers: 1 + ReservationActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TargetWorkers: target_workers + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /v1/Workspaces/{WorkspaceSid}/TaskQueues/RealTimeStatistics: + servers: + - url: https://taskrouter.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - account_sid + - workspace_sid + mountName: bulk_real_time_statistics + className: task_queue_bulk_real_time_statistics + pathType: list + post: + description: Fetch a Task Queue Real Time Statistics in bulk for the array of + TaskQueue SIDs, support upto 50 in a request. + parameters: + - name: WorkspaceSid + in: path + description: The unique SID identifier of the Workspace. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WS[0-9a-fA-F]{32}$ + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/taskrouter.v1.task_queue_bulk_real_time_statistics' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics + task_queue_data: + WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa: + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_tasks: 100 + total_eligible_workers: 100 + total_available_workers: 100 + tasks_by_status: + reserved: 0 + pending: 0 + assigned: 0 + wrapping: 0 + tasks_by_priority: {} + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_response_count: 100 + description: Created + security: + - accountSid_authToken: [] + operationId: CreateTaskQueueBulkRealTimeStatistics /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - start_time - end_time - avg_task_acceptance_time - tasks_completed - pathType: instance parent: /Workspaces/{WorkspaceSid}/TaskQueues/{Sid} className: task_queue_cumulative_statistics + pathType: instance get: description: '' parameters: @@ -3325,6 +4068,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -3338,6 +4084,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -3360,24 +4109,73 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics' + examples: + fetch: + value: + reservations_created: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_rejected: 100 + tasks_completed: 100 + end_time: '2015-07-30T20:00:00Z' + tasks_entered: 100 + tasks_canceled: 100 + reservations_accepted: 100 + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_timed_out: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + wait_duration_until_canceled: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_in_queue_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + split_by_wait_time: + '5': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + '10': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + start_time: '2015-07-30T20:00:00Z' + tasks_moved: 100 + reservations_canceled: 100 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_deleted: 100 + reservations_rescinded: 100 + avg_task_acceptance_time: 100 description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueueCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - longest_task_waiting_age - longest_task_waiting_sid - total_tasks - pathType: instance parent: /Workspaces/{WorkspaceSid}/TaskQueues/{Sid} className: task_queue_real_time_statistics + pathType: instance get: description: '' parameters: @@ -3405,28 +4203,62 @@ paths: SID or its `unique_name`, such as `voice`, `sms`, or `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics' + examples: + fetch: + value: + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + longest_relative_task_age_in_queue: 100 + longest_relative_task_sid_in_queue: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + reserved: 0 + pending: 0 + assigned: 0 + wrapping: 0 + total_eligible_workers: 100 + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_priority: {} + total_tasks: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_available_workers: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueueRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/TaskQueues/{Sid} className: task_queue_statistics + pathType: instance get: description: '' parameters: @@ -3456,12 +4288,18 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. The default is 15 minutes. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -3469,6 +4307,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate real-time and cumulative statistics for the specified @@ -3490,22 +4331,71 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + cumulative: + avg_task_acceptance_time: 0.0 + end_time: '2015-08-18T08:42:34Z' + reservations_accepted: 0 + reservations_canceled: 0 + reservations_created: 0 + reservations_rejected: 0 + reservations_rescinded: 0 + reservations_timed_out: 0 + start_time: '2015-08-18T08:27:34Z' + tasks_canceled: 0 + tasks_deleted: 0 + tasks_entered: 0 + tasks_moved: 0 + realtime: + activity_statistics: + - friendly_name: Offline + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Idle + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Reserved + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Busy + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 0 + pending: 0 + reserved: 0 + wrapping: 0 + total_available_workers: 0 + total_eligible_workers: 0 + total_tasks: 0 + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskQueueStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: list parent: /Workspaces/{WorkspaceSid}/TaskQueues className: task_queues_statistics + pathType: list get: description: '' parameters: @@ -3526,17 +4416,32 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02T00:00:00Z' + readEmpty: + value: '2008-01-02T00:00:00Z' - name: FriendlyName in: query description: The `friendly_name` of the TaskQueue statistics to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. The default is 15 minutes. schema: type: integer + examples: + readFull: + value: 1 + readEmpty: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -3544,6 +4449,11 @@ paths: schema: type: string format: date-time + examples: + readFull: + value: '2008-01-02T00:00:00Z' + readEmpty: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's @@ -3590,34 +4500,102 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queues_statistics' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + key: task_queues_statistics + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + task_queues_statistics: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cumulative: + avg_task_acceptance_time: 0.0 + end_time: '2015-08-18T08:46:15Z' + reservations_accepted: 0 + reservations_canceled: 0 + reservations_created: 0 + reservations_rejected: 0 + reservations_rescinded: 0 + reservations_timed_out: 0 + start_time: '2015-08-18T08:31:15Z' + tasks_canceled: 0 + tasks_deleted: 0 + tasks_entered: 0 + tasks_moved: 0 + realtime: + activity_statistics: + - friendly_name: Offline + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Idle + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Reserved + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Busy + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 0 + pending: 0 + reserved: 0 + wrapping: 0 + total_available_workers: 0 + total_eligible_workers: 0 + total_tasks: 0 + task_queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + key: task_queues_statistics + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics?FriendlyName=friendly_name&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-02T00%3A00%3A00Z&Minutes=1&PageSize=50&Page=0 + task_queues_statistics: [] description: OK security: - accountSid_authToken: [] operationId: ListTaskQueuesStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations: servers: - url: https://taskrouter.twilio.com @@ -3628,8 +4606,8 @@ paths: - reservation_status - worker_name - worker_sid - pathType: list parent: /Workspaces/{WorkspaceSid}/Tasks/{Sid} + pathType: list get: description: '' parameters: @@ -3700,34 +4678,69 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.task.task_reservation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: [] description: OK security: - accountSid_authToken: [] operationId: ListTaskReservation - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}: servers: - url: https://taskrouter.twilio.com @@ -3738,8 +4751,8 @@ paths: - reservation_status - worker_name - worker_sid - pathType: instance parent: /Workspaces/{WorkspaceSid}/Tasks/{Sid} + pathType: instance get: description: '' parameters: @@ -3778,12 +4791,27 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task.task_reservation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTaskReservation - x-maturity: - - GA post: description: '' parameters: @@ -3827,12 +4855,43 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.task.task_reservation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateSuperviseInstruction: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateTaskReservation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4136,16 +5195,24 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. + examples: + update: + value: + ReservationStatus: accepted + updateSuperviseInstruction: + value: + Instruction: supervise + SupervisorMode: monitor + Supervisor: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Workspaces/{WorkspaceSid}/Workers: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - available - pathType: list dependentProperties: workers_real_time_statistics: '{workspace_sid: workspace_sid}' workers_cumulative_statistics: '{workspace_sid: workspace_sid}' @@ -4153,6 +5220,7 @@ paths: reservation: '{workspace_sid: workspace_sid, worker_sid: sid}' worker_channel: '{workspace_sid: workspace_sid, worker_sid: sid}' parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -4170,6 +5238,11 @@ paths: description: The `activity_name` of the Worker resources to read. schema: type: string + examples: + readFull: + value: activity_name + readEmpty: + value: activity_name - name: ActivitySid in: query description: The `activity_sid` of the Worker resources to read. @@ -4178,6 +5251,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WA[0-9a-fA-F]{32}$ + examples: + readFull: + value: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Available in: query description: Whether to return only Worker resources that are available or @@ -4186,23 +5264,44 @@ paths: are not available. schema: type: string + examples: + readFull: + value: available + readEmpty: + value: available - name: FriendlyName in: query description: The `friendly_name` of the Worker resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: TargetWorkersExpression in: query - description: Filter by Workers that would match an expression on a TaskQueue. - This is helpful for debugging which Workers would match a potential queue. + description: 'Filter by Workers that would match an expression. In addition + to fields in the workers'' attributes, the expression can include the following + worker fields: `sid`, `friendly_name`, `activity_sid`, or `activity_name`' schema: type: string + examples: + readFull: + value: target_workers_expression + readEmpty: + value: target_workers_expression - name: TaskQueueName in: query description: The `friendly_name` of the TaskQueue that the Workers to read are eligible for. schema: type: string + examples: + readFull: + value: task_queue_name + readEmpty: + value: task_queue_name - name: TaskQueueSid in: query description: The SID of the TaskQueue that the Workers to read are eligible @@ -4212,6 +5311,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ + examples: + readFull: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Ordering in: query description: Sorting parameter for Workers @@ -4249,34 +5353,78 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + next_page_url: null + key: workers + workers: + - sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: testWorker + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: Offline + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:05:29Z' + date_updated: '2017-05-30T23:05:29Z' + date_status_changed: '2017-05-30T23:05:29Z' + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + key: workers + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers?Available=available&TargetWorkersExpression=target_workers_expression&TaskQueueName=task_queue_name&ActivityName=activity_name&ActivitySid=WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=friendly_name&PageSize=50&Page=0 + workers: [] description: OK security: - accountSid_authToken: [] operationId: ListWorker - x-maturity: - - GA post: description: '' parameters: @@ -4295,12 +5443,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' + examples: + create: + value: + sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: NewWorker + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: Offline + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:19:38Z' + date_updated: '2017-05-30T23:19:38Z' + date_status_changed: '2017-05-30T23:19:38Z' + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: Created security: - accountSid_authToken: [] operationId: CreateWorker - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4329,16 +5501,22 @@ paths: TaskRouter assigns a Task to the Worker. Defaults to {}.' required: - FriendlyName + examples: + create: + value: + ActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: attributes + FriendlyName: friendly_name + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Workspaces/{WorkspaceSid}/Workers/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - available - pathType: instance dependentProperties: workers_real_time_statistics: '{workspace_sid: workspace_sid}' workers_cumulative_statistics: '{workspace_sid: workspace_sid}' @@ -4346,6 +5524,7 @@ paths: reservation: '{workspace_sid: workspace_sid, worker_sid: sid}' worker_channel: '{workspace_sid: workspace_sid, worker_sid: sid}' parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -4373,12 +5552,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: available + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:32:39Z' + date_status_changed: '2017-05-30T23:32:39Z' + date_updated: '2017-05-30T23:32:39Z' + friendly_name: NewWorker3 + sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: FetchWorker - x-maturity: - - GA post: description: '' parameters: @@ -4411,12 +5614,36 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker' + examples: + update: + value: + sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: blah + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + activity_name: Offline + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: '{}' + available: false + date_created: '2017-05-30T23:32:22Z' + date_updated: '2017-05-31T00:05:57Z' + date_status_changed: '2017-05-30T23:32:22Z' + operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + activity: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities/WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + worker_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + worker_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels + reservations: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations description: OK security: - accountSid_authToken: [] operationId: UpdateWorker - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4447,6 +5674,13 @@ paths: description: Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`. + examples: + update: + value: + ActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Attributes: attributes + FriendlyName: friendly_name + OperatingUnitSid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' parameters: @@ -4479,20 +5713,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWorker - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - task_channel_sid - task_channel_unique_name - pathType: list parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} mountName: worker_channels + pathType: list get: description: '' parameters: @@ -4546,46 +5778,80 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_channel' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + channels: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_tasks: 0 + available: true + available_capacity_percentage: 100 + configured_capacity: 1 + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + sid: WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + key: channels + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 + channels: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkerChannel - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - task_channel_sid - task_channel_unique_name - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} mountName: worker_channels + pathType: instance get: description: '' parameters: @@ -4619,12 +5885,26 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_channel' + examples: + fetchSid: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_tasks: 0 + available: true + available_capacity_percentage: 100 + configured_capacity: 1 + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + sid: WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkerChannel - x-maturity: - - GA post: description: '' parameters: @@ -4658,12 +5938,26 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_channel' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assigned_tasks: 0 + available: true + available_capacity_percentage: 100 + configured_capacity: 3 + date_created: '2016-04-14T17:35:54Z' + date_updated: '2016-04-14T17:35:54Z' + sid: WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_channel_unique_name: default + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/WCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkerChannel - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4682,16 +5976,20 @@ paths: description: Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type. + examples: + update: + value: + Capacity: 3 /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} className: worker_statistics + pathType: instance get: description: '' parameters: @@ -4721,6 +6019,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -4728,6 +6029,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only include usage that occurred on or before this date, specified @@ -4735,6 +6039,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's @@ -4747,12 +6054,51 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_instance_statistics' + examples: + fetch: + value: + cumulative: + reservations_created: 100 + reservations_accepted: 100 + reservations_rejected: 100 + reservations_timed_out: 100 + reservations_canceled: 100 + reservations_rescinded: 100 + activity_durations: + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Offline + avg: 1080 + total: 5400 + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Busy + avg: 1012 + total: 8100 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Idle + avg: 0 + total: 0 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Reserved + avg: 0 + total: 0 + start_time: '2008-01-02T00:00:00Z' + end_time: '2008-01-02T00:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics description: OK security: - accountSid_authToken: [] operationId: FetchWorkerInstanceStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations: servers: - url: https://taskrouter.twilio.com @@ -4762,8 +6108,8 @@ paths: - sid - reservation_status - date_created - pathType: list parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} + pathType: list get: description: '' parameters: @@ -4827,34 +6173,69 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + key: reservations + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0 + reservations: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkerReservation - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}: servers: - url: https://taskrouter.twilio.com @@ -4864,8 +6245,8 @@ paths: - sid - reservation_status - date_created - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} + pathType: instance get: description: '' parameters: @@ -4904,12 +6285,27 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkerReservation - x-maturity: - - GA post: description: '' parameters: @@ -4953,12 +6349,27 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:03:42Z' + links: + task: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservation_status: accepted + sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + worker_name: Doug + worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkerReservation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5256,16 +6667,20 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. + examples: + update: + value: + ReservationStatus: accepted /v1/Workspaces/{WorkspaceSid}/Workers/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers className: workers_statistics + pathType: instance get: description: '' parameters: @@ -5286,6 +6701,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -5293,6 +6711,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only calculate statistics from this date and time and earlier, @@ -5301,6 +6722,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskQueueSid in: query description: The SID of the TaskQueue for which to fetch Worker statistics. @@ -5333,16 +6757,69 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.worker_statistics' + examples: + fetch: + value: + cumulative: + reservations_created: 0 + reservations_accepted: 0 + reservations_rejected: 0 + reservations_timed_out: 0 + reservations_canceled: 0 + reservations_rescinded: 0 + activity_durations: + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Offline + avg: 1080 + total: 5400 + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Busy + avg: 1012 + total: 8100 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Idle + avg: 0 + total: 0 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Reserved + avg: 0 + total: 0 + start_time: '2008-01-02T00:00:00Z' + end_time: '2008-01-02T00:00:00Z' + realtime: + total_workers: 15 + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/Statistics description: OK security: - accountSid_authToken: [] operationId: FetchWorkerStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - reservations_created @@ -5351,9 +6828,9 @@ paths: - reservations_timed_out - reservations_canceled - reservations_rescinded - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} className: workers_cumulative_statistics + pathType: instance get: description: '' parameters: @@ -5373,6 +6850,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -5388,6 +6868,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -5401,22 +6884,59 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.workers_cumulative_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/CumulativeStatistics + reservations_created: 100 + reservations_accepted: 100 + reservations_rejected: 100 + reservations_timed_out: 100 + reservations_canceled: 100 + reservations_rescinded: 100 + activity_durations: + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Offline + avg: 1080 + total: 5400 + - max: 0 + min: 900 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Busy + avg: 1012 + total: 8100 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Idle + avg: 0 + total: 0 + - max: 0 + min: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Reserved + avg: 0 + total: 0 + start_time: '2015-07-30T20:00:00Z' + end_time: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: FetchWorkersCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - total_workers - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workers/{Sid} className: workers_real_time_statistics + pathType: instance get: description: '' parameters: @@ -5436,28 +6956,48 @@ paths: `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.worker.workers_real_time_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/RealTimeStatistics + total_workers: 15 + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkersRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - document_content_type - pathType: instance dependentProperties: workflow_statistics: '{workspace_sid: workspace_sid, workflow_sid: sid}' workflow_real_time_statistics: '{workspace_sid: workspace_sid, workflow_sid: @@ -5465,6 +7005,7 @@ paths: workflow_cumulative_statistics: '{workspace_sid: workspace_sid, workflow_sid: sid}' parent: /Workspaces/{Sid} + pathType: instance get: description: '' parameters: @@ -5492,12 +7033,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics description: OK security: - accountSid_authToken: [] operationId: FetchWorkflow - x-maturity: - - GA post: description: '' parameters: @@ -5525,12 +7085,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkflow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5569,6 +7148,15 @@ paths: description: Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again. + examples: + update: + value: + AssignmentCallbackUrl: http://example.com + Configuration: configuration + FallbackAssignmentCallbackUrl: http://example.com + FriendlyName: friendly_name + TaskReservationTimeout: 1 + ReEvaluateTasks: 'false' delete: description: '' parameters: @@ -5596,18 +7184,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWorkflow - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - document_content_type - pathType: list dependentProperties: workflow_statistics: '{workspace_sid: workspace_sid, workflow_sid: sid}' workflow_real_time_statistics: '{workspace_sid: workspace_sid, workflow_sid: @@ -5615,6 +7200,7 @@ paths: workflow_cumulative_statistics: '{workspace_sid: workspace_sid, workflow_sid: sid}' parent: /Workspaces/{Sid} + pathType: list get: description: '' parameters: @@ -5632,6 +7218,11 @@ paths: description: The `friendly_name` of the Workflow resources to read. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5664,34 +7255,73 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workflows + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + workflows: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-15T16:47:51Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workflows + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows?FriendlyName=friendly_name&PageSize=50&Page=0 + workflows: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkflow - x-maturity: - - GA post: description: '' parameters: @@ -5711,12 +7341,31 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + assignment_callback_url: http://example.com + configuration: 'task-routing:\n - filter: \n - 1 == 1\n target:\n - + queue: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n set-priority: + 0\n' + date_created: '2014-05-14T10:50:02Z' + date_updated: '2014-05-14T23:26:06Z' + document_content_type: application/json + fallback_assignment_callback_url: null + friendly_name: Default Fifo Workflow + sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + task_reservation_timeout: 120 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics description: Created security: - accountSid_authToken: [] operationId: CreateWorkflow - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -5753,19 +7402,27 @@ paths: required: - FriendlyName - Configuration + examples: + create: + value: + AssignmentCallbackUrl: http://example.com + Configuration: configuration + FallbackAssignmentCallbackUrl: http://example.com + FriendlyName: friendly_name + TaskReservationTimeout: 1 /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - start_time - end_time - avg_task_acceptance_time - tasks_completed - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workflows/{Sid} className: workflow_cumulative_statistics + pathType: instance get: description: '' parameters: @@ -5795,6 +7452,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -5810,6 +7470,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -5835,24 +7498,69 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow.workflow_cumulative_statistics' + examples: + fetch: + value: + avg_task_acceptance_time: 100 + tasks_canceled: 100 + start_time: '2015-07-30T20:00:00Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_moved: 100 + tasks_entered: 100 + wait_duration_until_canceled: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + split_by_wait_time: + '5': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + '10': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + reservations_canceled: 100 + end_time: '2015-07-30T20:00:00Z' + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_created: 100 + reservations_accepted: 100 + reservations_rescinded: 100 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reservations_rejected: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + tasks_deleted: 100 + tasks_timed_out_in_workflow: 100 + tasks_completed: 100 + reservations_timed_out: 100 description: OK security: - accountSid_authToken: [] operationId: FetchWorkflowCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - longest_task_waiting_age - longest_task_waiting_sid - total_tasks - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workflows/{Sid} className: workflow_real_time_statistics + pathType: instance get: description: '' parameters: @@ -5882,28 +7590,45 @@ paths: `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow.workflow_real_time_statistics' + examples: + fetch: + value: + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + tasks_by_priority: {} + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + reserved: 0 + pending: 0 + assigned: 0 + wrapping: 0 + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_tasks: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkflowRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{WorkspaceSid}/Workflows/{Sid} className: workflow_statistics + pathType: instance get: description: '' parameters: @@ -5934,6 +7659,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -5941,6 +7669,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only calculate statistics from this date and time and earlier, @@ -5949,6 +7680,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate real-time statistics on this TaskChannel. Can @@ -5973,22 +7707,46 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workflow.workflow_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows/WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + cumulative: + avg_task_acceptance_time: 0.0 + end_time: '2008-01-02T00:00:00Z' + reservations_accepted: 0 + reservations_rejected: 0 + reservations_timed_out: 0 + start_time: '2008-01-02T00:00:00Z' + tasks_canceled: 0 + tasks_entered: 0 + tasks_moved: 0 + tasks_timed_out_in_workflow: 0 + realtime: + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 1 + pending: 0 + reserved: 0 + wrapping: 0 + total_tasks: 1 + workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkflowStatistics - x-maturity: - - GA /v1/Workspaces/{Sid}: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - prioritize_queue_order - pathType: instance dependentProperties: activity: '{workspace_sid: sid}' event: '{workspace_sid: sid}' @@ -6000,6 +7758,7 @@ paths: workspace_real_time_statistics: '{workspace_sid: sid}' workspace_cumulative_statistics: '{workspace_sid: sid}' task_channel: '{workspace_sid: sid}' + pathType: instance get: description: '' parameters: @@ -6018,12 +7777,39 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkspace - x-maturity: - - GA post: description: '' parameters: @@ -6042,12 +7828,39 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateWorkspace - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6106,6 +7919,13 @@ paths: description: 'The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' + examples: + update: + value: + DefaultActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EventCallbackUrl: /example + FriendlyName: friendly_name + TimeoutActivitySid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: '' parameters: @@ -6124,18 +7944,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWorkspace - x-maturity: - - GA /v1/Workspaces: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - prioritize_queue_order - pathType: list dependentProperties: activity: '{workspace_sid: sid}' event: '{workspace_sid: sid}' @@ -6147,6 +7964,7 @@ paths: workspace_real_time_statistics: '{workspace_sid: sid}' workspace_cumulative_statistics: '{workspace_sid: sid}' task_channel: '{workspace_sid: sid}' + pathType: list get: description: '' parameters: @@ -6156,6 +7974,11 @@ paths: `Customer Support` or `2014 Election Campaign`. schema: type: string + examples: + readFull: + value: friendly_name + readEmpty: + value: friendly_name - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6188,34 +8011,81 @@ paths: items: $ref: '#/components/schemas/taskrouter.v1.workspace' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workspaces + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + workspaces: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + key: workspaces + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://taskrouter.twilio.com/v1/Workspaces?FriendlyName=friendly_name&PageSize=50&Page=0 + workspaces: [] description: OK security: - accountSid_authToken: [] operationId: ListWorkspace - x-maturity: - - GA post: description: '' responses: @@ -6224,12 +8094,39 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-08-01T22:10:40Z' + date_updated: '2016-08-01T22:10:40Z' + default_activity_name: Offline + default_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + event_callback_url: '' + events_filter: null + friendly_name: new + links: + activities: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Activities + statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + task_queues: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues + tasks: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks + workers: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers + workflows: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workflows + task_channels: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels + events: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events + multi_task_enabled: false + prioritize_queue_order: FIFO + sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + timeout_activity_name: Offline + timeout_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_operating_unit_sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateWorkspace - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -6284,19 +8181,25 @@ paths: [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).' required: - FriendlyName + examples: + create: + value: + EventCallbackUrl: /example + FriendlyName: friendly_name + Template: template /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - start_time - end_time - avg_task_acceptance_time - tasks_completed - pathType: instance parent: /Workspaces/{Sid} className: workspace_cumulative_statistics + pathType: instance get: description: '' parameters: @@ -6316,6 +8219,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Minutes in: query description: Only calculate statistics since this many minutes in the past. @@ -6331,6 +8237,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: TaskChannel in: query description: Only calculate cumulative statistics on this TaskChannel. Can @@ -6356,24 +8265,68 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workspace_cumulative_statistics' + examples: + fetch: + value: + reservations_accepted: 100 + tasks_completed: 100 + start_time: '2015-07-30T20:00:00Z' + reservations_rescinded: 100 + tasks_timed_out_in_workflow: 100 + end_time: '2015-07-30T20:00:00Z' + avg_task_acceptance_time: 100 + tasks_canceled: 100 + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics + tasks_moved: 100 + tasks_deleted: 100 + tasks_created: 100 + reservations_canceled: 100 + reservations_timed_out: 100 + wait_duration_until_canceled: + avg: 0 + min: 0 + max: 0 + total: 0 + wait_duration_until_accepted: + avg: 0 + min: 0 + max: 0 + total: 0 + split_by_wait_time: + '5': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + '10': + above: + tasks_canceled: 0 + reservations_accepted: 0 + below: + tasks_canceled: 0 + reservations_accepted: 0 + reservations_created: 100 + reservations_rejected: 100 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkspaceCumulativeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - longest_task_waiting_age - longest_task_waiting_sid - total_tasks - pathType: instance parent: /Workspaces/{Sid} className: workspace_real_time_statistics + pathType: instance get: description: '' parameters: @@ -6393,28 +8346,54 @@ paths: `default`. schema: type: string + examples: + fetch: + value: voice responses: '200': content: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workspace_real_time_statistics' + examples: + fetch: + value: + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics + tasks_by_priority: {} + activity_statistics: + - friendly_name: Idle + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Busy + workers: 9 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Offline + workers: 6 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - friendly_name: Reserved + workers: 0 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + longest_task_waiting_age: 100 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + total_workers: 100 + total_tasks: 100 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: {} description: OK security: - accountSid_authToken: [] operationId: FetchWorkspaceRealTimeStatistics - x-maturity: - - GA /v1/Workspaces/{WorkspaceSid}/Statistics: servers: - url: https://taskrouter.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - cumulative - pathType: instance parent: /Workspaces/{Sid} className: workspace_statistics + pathType: instance get: description: '' parameters: @@ -6435,6 +8414,9 @@ paths: trends. schema: type: integer + examples: + fetch: + value: 1 - name: StartDate in: query description: Only calculate statistics from this date and time and later, @@ -6442,6 +8424,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: EndDate in: query description: Only calculate statistics from this date and time and earlier, @@ -6450,6 +8435,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2008-01-02T00:00:00Z' - name: TaskChannel in: query description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's @@ -6473,14 +8461,59 @@ paths: application/json: schema: $ref: '#/components/schemas/taskrouter.v1.workspace.workspace_statistics' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics + cumulative: + avg_task_acceptance_time: 0.0 + start_time: '2008-01-02T00:00:00Z' + reservations_accepted: 0 + reservations_canceled: 0 + reservations_created: 0 + reservations_rejected: 0 + reservations_rescinded: 0 + reservations_timed_out: 0 + end_time: '2008-01-02T00:00:00Z' + tasks_canceled: 0 + tasks_created: 0 + tasks_deleted: 0 + tasks_moved: 0 + tasks_timed_out_in_workflow: 0 + realtime: + activity_statistics: + - friendly_name: Offline + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 1 + - friendly_name: Idle + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Reserved + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: Busy + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + - friendly_name: 817ca1c5-3a05-11e5-9292-98e0d9a1eb73 + sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + workers: 0 + longest_task_waiting_age: 0 + longest_task_waiting_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + tasks_by_status: + assigned: 0 + pending: 0 + reserved: 0 + wrapping: 0 + total_tasks: 0 + total_workers: 1 + workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchWorkspaceStatistics - x-maturity: - - GA servers: - url: https://taskrouter.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 27534bba..b772c3e3 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: trunking.v1.trunk.credential_list: type: object @@ -540,10 +544,6 @@ components: enum: - from-transferee - from-transferor - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Trunking description: This is the public Twilio REST API. @@ -555,7 +555,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}: @@ -567,10 +567,10 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Trunks/{Sid} mountName: credentials_lists className: credential_list + pathType: instance get: description: '' parameters: @@ -599,12 +599,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.credential_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-04-28T00:10:23Z' + date_updated: '2018-04-28T00:10:23Z' + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCredentialList - x-maturity: - - GA delete: description: '' parameters: @@ -633,8 +641,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCredentialList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/CredentialLists: servers: - url: https://trunking.twilio.com @@ -644,10 +650,10 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Trunks/{Sid} mountName: credentials_lists className: credential_list + pathType: list post: description: '' parameters: @@ -666,12 +672,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.credential_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-02T17:29:30Z' + date_updated: '2018-05-02T17:29:30Z' + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCredentialList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -689,6 +703,10 @@ paths: will authenticate access to the trunk against this list. required: - CredentialListSid + examples: + create: + value: + CredentialListSid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -733,34 +751,62 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.credential_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + credential_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-04-27T22:02:11Z' + date_updated: '2018-04-27T22:02:11Z' + friendly_name: friendly_name + sid: CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + next_page_url: null + key: credential_lists + readEmpty: + value: + credential_lists: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0 + next_page_url: null + key: credential_lists description: OK security: - accountSid_authToken: [] operationId: ListCredentialList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}: servers: - url: https://trunking.twilio.com @@ -770,8 +816,8 @@ paths: - sid - friendly_name - date_created - pathType: instance parent: /Trunks/{Sid} + pathType: instance get: description: '' parameters: @@ -801,12 +847,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-02T17:29:34Z' + date_updated: '2018-05-02T17:29:34Z' + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchIpAccessControlList - x-maturity: - - GA delete: description: Remove an associated IP Access Control List from a Trunk parameters: @@ -836,8 +890,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIpAccessControlList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/IpAccessControlLists: servers: - url: https://trunking.twilio.com @@ -847,8 +899,8 @@ paths: - sid - friendly_name - date_created - pathType: list parent: /Trunks/{Sid} + pathType: list post: description: Associate an IP Access Control List with a Trunk parameters: @@ -868,12 +920,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-04-30T20:59:06Z' + date_updated: '2018-04-30T20:59:06Z' + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateIpAccessControlList - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -890,6 +950,10 @@ paths: that you want to associate with the trunk. required: - IpAccessControlListSid + examples: + create: + value: + IpAccessControlListSid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: List all IP Access Control Lists for a Trunk parameters: @@ -935,34 +999,62 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + ip_access_control_lists: [] + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 + key: ip_access_control_lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 + readFull: + value: + ip_access_control_lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-02T17:29:34Z' + date_updated: '2018-05-02T17:29:34Z' + friendly_name: friendly_name + sid: ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 + key: ip_access_control_lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListIpAccessControlList - x-maturity: - - GA /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}: servers: - url: https://trunking.twilio.com @@ -974,8 +1066,8 @@ paths: - sip_url - priority - weight - pathType: instance parent: /Trunks/{Sid} + pathType: instance get: description: '' parameters: @@ -1004,12 +1096,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' + examples: + fetch: + value: + weight: 1 + date_updated: '2018-05-07T20:20:46Z' + enabled: false + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 1 + sip_url: sip://sip-box.com:1234 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-07T20:20:46Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchOriginationUrl - x-maturity: - - GA delete: description: '' parameters: @@ -1038,8 +1142,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteOriginationUrl - x-maturity: - - GA post: description: '' parameters: @@ -1068,12 +1170,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' + examples: + update: + value: + weight: 2 + date_updated: '2018-05-07T20:50:58Z' + enabled: false + friendly_name: updated_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 2 + sip_url: sip://sip-updated.com:4321 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-07T20:50:58Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateOriginationUrl - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1105,6 +1219,14 @@ paths: format: uri description: The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported. + examples: + update: + value: + FriendlyName: updated_name + Weight: 2 + Priority: 2 + SipUrl: sip://sip-updated.com:4321 + Enabled: false /v1/Trunks/{TrunkSid}/OriginationUrls: servers: - url: https://trunking.twilio.com @@ -1116,8 +1238,8 @@ paths: - sip_url - priority - weight - pathType: list parent: /Trunks/{Sid} + pathType: list post: description: '' parameters: @@ -1136,12 +1258,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' + examples: + create: + value: + weight: 1 + date_updated: '2018-05-07T20:50:58Z' + enabled: true + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 1 + sip_url: sip://sip-box.com:1234 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-07T20:50:58Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateOriginationUrl - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1179,6 +1313,14 @@ paths: - Enabled - FriendlyName - SipUrl + examples: + create: + value: + Enabled: true + FriendlyName: friendly_name + Priority: 1 + Weight: 1 + SipUrl: sip://sip-box.com:1234 get: description: '' parameters: @@ -1223,34 +1365,66 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.origination_url' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + key: origination_urls + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + origination_urls: + - weight: 1 + date_updated: '2018-05-09T20:47:35Z' + enabled: true + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + priority: 1 + sip_url: sip://sip-box.com:1234 + sid: OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2018-05-09T20:47:35Z' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls/OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + key: origination_urls + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls?PageSize=50&Page=0 + origination_urls: [] description: OK security: - accountSid_authToken: [] operationId: ListOriginationUrl - x-maturity: - - GA /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}: servers: - url: https://trunking.twilio.com @@ -1260,8 +1434,8 @@ paths: - sid - friendly_name - phone_number - pathType: instance parent: /Trunks/{Sid} + pathType: instance get: description: '' parameters: @@ -1290,12 +1464,43 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.phone_number' + examples: + fetch: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-12-10T17:27:34Z' + date_updated: '2015-10-09T11:36:32Z' + friendly_name: (415) 867-5309 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+14158675309' + api_version: '2010-04-01' + voice_caller_id_lookup: null + voice_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call + voice_method: POST + voice_fallback_url: null + voice_fallback_method: null + status_callback: '' + status_callback_method: POST + voice_application_sid: '' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + beta: false + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + capabilities: + voice: true + sms: true + mms: true + links: + phone_number: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber - x-maturity: - - GA delete: description: '' parameters: @@ -1324,8 +1529,6 @@ paths: security: - accountSid_authToken: [] operationId: DeletePhoneNumber - x-maturity: - - GA /v1/Trunks/{TrunkSid}/PhoneNumbers: servers: - url: https://trunking.twilio.com @@ -1335,8 +1538,8 @@ paths: - sid - friendly_name - phone_number - pathType: list parent: /Trunks/{Sid} + pathType: list post: description: '' parameters: @@ -1355,12 +1558,43 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.phone_number' + examples: + create: + value: + sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-12-10T17:27:34Z' + date_updated: '2015-10-09T11:36:32Z' + friendly_name: (415) 867-5309 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+14158675309' + api_version: '2010-04-01' + voice_caller_id_lookup: null + voice_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call + voice_method: POST + voice_fallback_url: null + voice_fallback_method: null + status_callback: '' + status_callback_method: POST + voice_application_sid: '' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + beta: false + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + capabilities: + voice: true + sms: true + mms: true + links: + phone_number: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1377,6 +1611,10 @@ paths: that you want to associate with the trunk. required: - PhoneNumberSid + examples: + create: + value: + PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -1421,34 +1659,85 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk.phone_number' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + key: phone_numbers + next_page_url: null + page: 0 + page_size: 1 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + phone_numbers: + - sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2010-12-10T17:27:34Z' + date_updated: '2015-10-09T11:36:32Z' + friendly_name: (415) 867-5309 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+14158675309' + api_version: '2010-04-01' + voice_caller_id_lookup: null + voice_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Call + voice_method: POST + voice_fallback_url: null + voice_fallback_method: null + status_callback: '' + status_callback_method: POST + voice_application_sid: '' + trunk_sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sms_url: https://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Proxy/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/Message + sms_method: POST + sms_fallback_url: '' + sms_fallback_method: POST + sms_application_sid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_requirements: none + beta: false + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + capabilities: + voice: true + sms: true + mms: true + links: + phone_number: https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IncomingPhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json + readEmpty: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + key: phone_numbers + next_page_url: null + page: 0 + page_size: 1 + previous_page_url: null + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=1&Page=0 + phone_numbers: [] description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber - x-maturity: - - GA /v1/Trunks/{TrunkSid}/Recording: servers: - url: https://trunking.twilio.com @@ -1457,9 +1746,9 @@ paths: defaultOutputProperties: - mode - trim - pathType: instance parent: /Trunks/{Sid} mountName: recordings + pathType: instance get: description: '' parameters: @@ -1478,12 +1767,15 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.recording' + examples: + fetch: + value: + mode: do-not-record + trim: do-not-trim description: OK security: - accountSid_authToken: [] operationId: FetchRecording - x-maturity: - - GA post: description: '' parameters: @@ -1502,12 +1794,15 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk.recording' + examples: + update: + value: + mode: do-not-record + trim: do-not-trim description: Accepted security: - accountSid_authToken: [] operationId: UpdateRecording - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1526,6 +1821,11 @@ paths: $ref: '#/components/schemas/recording_enum_recording_trim' description: The recording trim setting for the trunk. Can be do-not-trim (default) or trim-silence. + examples: + update: + value: + Mode: do-not-record + Trim: do-not-trim /v1/Trunks/{Sid}: servers: - url: https://trunking.twilio.com @@ -1535,13 +1835,13 @@ paths: - sid - friendly_name - domain_name - pathType: instance dependentProperties: origination_url: '{trunk_sid: sid}' credential_list: '{trunk_sid: sid}' ip_access_control_list: '{trunk_sid: sid}' phone_number: '{trunk_sid: sid}' recording: '{trunk_sid: sid}' + pathType: instance get: description: '' parameters: @@ -1561,12 +1861,36 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk' + examples: + fetch: + value: + sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: POST + disaster_recovery_url: http://disaster-recovery.com + friendly_name: friendly_name + secure: false + cnam_lookup_enabled: false + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferor + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers description: OK security: - accountSid_authToken: [] operationId: FetchTrunk - x-maturity: - - GA delete: description: '' parameters: @@ -1586,8 +1910,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrunk - x-maturity: - - GA post: description: '' parameters: @@ -1607,12 +1929,36 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk' + examples: + update: + value: + sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: GET + disaster_recovery_url: http://updated-recovery.com + friendly_name: updated_name + secure: true + cnam_lookup_enabled: true + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferor + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers description: OK security: - accountSid_authToken: [] operationId: UpdateTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1676,6 +2022,16 @@ paths: $ref: '#/components/schemas/trunk_enum_transfer_caller_id' description: 'Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.' + examples: + update: + value: + FriendlyName: updated_name + DisasterRecoveryMethod: GET + DisasterRecoveryUrl: http://updated-recovery.com + Secure: true + TransferMode: disable-all + TransferCallerId: from-transferor + CnamLookupEnabled: true /v1/Trunks: servers: - url: https://trunking.twilio.com @@ -1685,13 +2041,13 @@ paths: - sid - friendly_name - domain_name - pathType: list dependentProperties: origination_url: '{trunk_sid: sid}' credential_list: '{trunk_sid: sid}' ip_access_control_list: '{trunk_sid: sid}' phone_number: '{trunk_sid: sid}' recording: '{trunk_sid: sid}' + pathType: list post: description: '' responses: @@ -1700,12 +2056,36 @@ paths: application/json: schema: $ref: '#/components/schemas/trunking.v1.trunk' + examples: + create: + value: + sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: POST + disaster_recovery_url: http://disaster-recovery.com + friendly_name: friendly_name + secure: false + cnam_lookup_enabled: false + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferee + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers description: Created security: - accountSid_authToken: [] operationId: CreateTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1769,6 +2149,17 @@ paths: $ref: '#/components/schemas/trunk_enum_transfer_caller_id' description: 'Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.' + examples: + create: + value: + DomainName: test.pstn.twilio.com + FriendlyName: friendly_name + DisasterRecoveryMethod: GET + DisasterRecoveryUrl: http://disaster-recovery.com + TransferMode: disable-all + TransferCallerId: from-transferee + Secure: false + CnamLookupEnabled: false get: description: '' parameters: @@ -1804,36 +2195,77 @@ paths: items: $ref: '#/components/schemas/trunking.v1.trunk' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + page_size: 50 + key: trunks + next_page_url: null + page: 0 + previous_page_url: null + trunks: + - sid: TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + domain_name: test.pstn.twilio.com + disaster_recovery_method: POST + disaster_recovery_url: http://disaster-recovery.com + friendly_name: friendly_name + secure: false + cnam_lookup_enabled: false + recording: + mode: do-not-record + trim: do-not-trim + transfer_mode: disable-all + transfer_caller_id: from-transferee + auth_type: '' + auth_type_set: [] + date_created: '2015-01-02T11:23:45Z' + date_updated: '2015-01-02T11:23:45Z' + url: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + origination_urls: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls + credential_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists + ip_access_control_lists: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists + phone_numbers: https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers + readEmpty: + value: + meta: + first_page_url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + url: https://trunking.twilio.com/v1/Trunks?PageSize=50&Page=0 + page_size: 50 + key: trunks + next_page_url: null + page: 0 + previous_page_url: null + trunks: [] description: OK security: - accountSid_authToken: [] operationId: ListTrunk - x-maturity: - - GA servers: - url: https://trunking.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index ea16ee84..127a1b2e 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: trusthub.v1.customer_profile: type: object @@ -689,10 +693,6 @@ components: enum: - compliant - noncompliant - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Trusthub description: This is the public Twilio REST API. @@ -704,24 +704,24 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/CustomerProfiles: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: list dependentProperties: customer_profiles_entity_assignments: '{customer_profile_sid: sid}' customer_profiles_evaluations: '{customer_profile_sid: sid}' customer_profiles_channel_endpoint_assignment: '{customer_profile_sid: sid}' className: customer_profiles + pathType: list post: description: Create a new Customer-Profile. responses: @@ -730,12 +730,28 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfile - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -766,6 +782,13 @@ paths: - FriendlyName - Email - PolicySid + examples: + create: + value: + FriendlyName: friendly_name + Email: email + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + StatusCallback: http://www.example.com get: description: Retrieve a list of all Customer-Profiles for an account. parameters: @@ -775,11 +798,17 @@ paths: schema: type: string $ref: '#/components/schemas/customer_profile_enum_status' + examples: + readFull: + value: draft - name: FriendlyName in: query description: The string that you assigned to describe the resource. schema: type: string + examples: + readFull: + value: friendly_name - name: PolicySid in: query description: The unique string of a policy that is associated to the Customer-Profile @@ -789,6 +818,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ + examples: + readFull: + value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -821,49 +853,85 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: provisionally-approved + email: email + status_callback: http://www.example.com + valid_until: '2020-07-31T01:00:00Z' + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfile - x-maturity: - - GA /v1/CustomerProfiles/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: instance dependentProperties: customer_profiles_entity_assignments: '{customer_profile_sid: sid}' customer_profiles_evaluations: '{customer_profile_sid: sid}' customer_profiles_channel_endpoint_assignment: '{customer_profile_sid: sid}' className: customer_profiles + pathType: instance get: description: Fetch a specific Customer-Profile instance. parameters: @@ -883,12 +951,28 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' + examples: + fetch: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: null + email: email + status_callback: http://www.example.com + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfile - x-maturity: - - GA post: description: Updates a Customer-Profile in an account. parameters: @@ -908,12 +992,45 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' + examples: + update: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments + updateToInReview: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: in-review + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: UpdateCustomerProfile - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -937,6 +1054,16 @@ paths: type: string description: The email address that will receive updates when the Customer-Profile resource changes status. + examples: + update: + value: + Status: draft + StatusCallback: http://www.example.com + FriendlyName: friendly_name + Email: email + updateToInReview: + value: + Status: pending-review delete: description: Delete a specific Customer-Profile. parameters: @@ -956,18 +1083,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCustomerProfile - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /CustomerProfiles/{Sid} mountName: customer_profiles_channel_endpoint_assignment + pathType: list post: description: Create a new Assigned Item. parameters: @@ -987,12 +1112,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' + examples: + create: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileChannelEndpointAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1012,6 +1145,11 @@ paths: required: - ChannelEndpointType - ChannelEndpointSid + examples: + create: + value: + ChannelEndpointSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelEndpointType: phone-number get: description: Retrieve a list of all Assigned Items for an account. parameters: @@ -1033,6 +1171,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readFull: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: ChannelEndpointSids in: query description: comma separated list of channel endpoint sids @@ -1070,44 +1211,72 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileChannelEndpointAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /CustomerProfiles/{Sid} mountName: customer_profiles_channel_endpoint_assignment + pathType: instance get: description: Fetch specific Assigned Item Instance. parameters: @@ -1136,12 +1305,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' + examples: + fetch: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileChannelEndpointAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. parameters: @@ -1170,19 +1347,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCustomerProfileChannelEndpointAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /CustomerProfiles/{Sid} mountName: customer_profiles_entity_assignments className: customer_profiles_entity_assignments + pathType: list post: description: Create a new Assigned Item. parameters: @@ -1202,12 +1377,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' + examples: + create: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileEntityAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1224,6 +1406,10 @@ paths: the different items. required: - ObjectSid + examples: + create: + value: + ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. parameters: @@ -1269,45 +1455,72 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileEntityAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /CustomerProfiles/{Sid} mountName: customer_profiles_entity_assignments className: customer_profiles_entity_assignments + pathType: instance get: description: Fetch specific Assigned Item Instance. parameters: @@ -1336,12 +1549,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' + examples: + fetch: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileEntityAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. parameters: @@ -1370,19 +1590,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCustomerProfileEntityAssignment - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /CustomerProfiles/{Sid} mountName: customer_profiles_evaluations className: customer_profiles_evaluations + pathType: list post: description: Create a new Evaluation parameters: @@ -1402,12 +1620,280 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' + examples: + create: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + createCompliantStarterCustomerProfile: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: compliant + date_created: '2023-03-15T13:51:57Z' + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - valid: + - object_field: first_name + error_code: null + friendly_name: First Name + passed: true + failure_reason: null + - object_field: last_name + error_code: null + friendly_name: Last Name + passed: true + failure_reason: null + - object_field: email + error_code: null + friendly_name: Email Address + passed: true + failure_reason: null + - object_field: phone_number + error_code: null + friendly_name: Phone Number + passed: true + failure_reason: null + invalid: [] + object_type: starter_customer_profile_information + friendly_name: Information + failure_reason: null + passed: true + requirement_friendly_name: Starter Customer Profile Information + error_code: null + requirement_name: starter_customer_profile_information + - valid: + - object_field: address_sids + error_code: null + friendly_name: address sids + passed: true + failure_reason: null + invalid: [] + object_type: customer_profile_address + friendly_name: Legal Company Address + failure_reason: null + passed: true + requirement_friendly_name: Customer Profile Address + error_code: null + requirement_name: customer_profile_address + - valid: + - object_field: bundle_sid + error_code: null + friendly_name: Supporting Bundle Status + passed: true + failure_reason: null + invalid: [] + object_type: primary_customer_profile_type_business + friendly_name: Primary Customer Profile Bundle + failure_reason: null + passed: true + requirement_friendly_name: Primary Customer Profile + error_code: null + requirement_name: primary_customer_profile + createCompliantSoleProprietorA2PProfile: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: compliant + date_created: '2023-03-15T13:51:57Z' + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - valid: + - object_field: brand_name + error_code: null + friendly_name: Brand Name + passed: true + failure_reason: null + - object_field: mobile_phone_number + error_code: null + friendly_name: Mobile Phone Number + passed: true + failure_reason: null + - object_field: vertical + error_code: null + friendly_name: Vertical + passed: true + failure_reason: null + invalid: [] + object_type: sole_proprietor_information + friendly_name: Sole Proprietor Information + failure_reason: null + passed: true + requirement_friendly_name: Sole Proprietor Information + error_code: null + requirement_name: sole_proprietor_information + - valid: + - object_field: bundle_status + error_code: null + friendly_name: Supporting Bundle Status + passed: true + failure_reason: null + invalid: [] + object_type: starter_customer_profile_type_business + friendly_name: Starter Customer Profile(isv customers) Proof + failure_reason: null + passed: true + requirement_friendly_name: Customer Profile + error_code: null + requirement_name: customer_profile description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileEvaluation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1424,6 +1910,16 @@ paths: the customer_profile resource. required: - PolicySid + examples: + create: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCompliantStarterCustomerProfile: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCompliantSoleProprietorA2PProfile: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Evaluations associated to the customer_profile resource. @@ -1470,45 +1966,218 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add + one to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the + Business information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter + in a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure + both Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in + the address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileEvaluation - x-maturity: - - GA /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /CustomerProfiles/{Sid} mountName: customer_profiles_evaluations className: customer_profiles_evaluations + pathType: instance get: description: Fetch specific Evaluation Instance. parameters: @@ -1537,16 +2206,169 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' + examples: + fetch: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileEvaluation - x-maturity: - - GA /v1/EndUsers: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1560,12 +2382,27 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' + examples: + create: + value: + date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: auth_rep_1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 description: Created security: - accountSid_authToken: [] operationId: CreateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1586,6 +2423,12 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: auth_rep_1 + Type: authorized_representative_1 + Attributes: '{}' get: description: Retrieve a list of all End User for an account. parameters: @@ -1621,38 +2464,73 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.end_user' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: auth_rep_1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListEndUser - x-maturity: - - GA /v1/EndUsers/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1677,12 +2555,27 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' + examples: + fetch: + value: + date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: auth_rep_1 + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 description: OK security: - accountSid_authToken: [] operationId: FetchEndUser - x-maturity: - - GA post: description: Update an existing End User. parameters: @@ -1702,12 +2595,27 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' + examples: + update: + value: + date_updated: '2021-02-16T20:40:57Z' + sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-16T20:40:57Z' + attributes: + phone_number: '+11234567890' + job_position: CEO + first_name: rep1 + last_name: test + business_title: ceo + email: foobar@test.com + type: authorized_representative_1 description: OK security: - accountSid_authToken: [] operationId: UpdateEndUser - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1721,6 +2629,11 @@ paths: Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific End User. parameters: @@ -1740,12 +2653,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEndUser - x-maturity: - - GA /v1/EndUserTypes: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1786,38 +2697,82 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.end_user_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + end_user_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 + next_page_url: null + key: end_user_types + end_user_types: + - url: https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: email + friendly_name: Email + constraint: String + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: business_title + friendly_name: Business Title + constraint: String + - machine_name: phone_number + friendly_name: Phone Number + constraint: String + - machine_name: job_position + friendly_name: Job Position + constraint: String + machine_name: authorized_representative_1 + friendly_name: Authorized Representative one + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListEndUserType - x-maturity: - - GA /v1/EndUserTypes/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1838,22 +2793,46 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user_type' + examples: + fetch: + value: + url: https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: email + friendly_name: Email + constraint: String + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: business_title + friendly_name: Business Title + constraint: String + - machine_name: phone_number + friendly_name: Phone Number + constraint: String + - machine_name: job_position + friendly_name: Job Position + constraint: String + machine_name: authorized_representative_1 + friendly_name: Authorized Representative one + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchEndUserType - x-maturity: - - GA /v1/Policies: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: list className: policies + pathType: list get: description: Retrieve a list of all Policys. parameters: @@ -1889,44 +2868,119 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.policies' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 + next_page_url: null + key: results + results: + - url: https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + requirements: + end_user: + - url: /EndUserTypes/customer_profile_business_information + fields: + - business_type + - business_registration_number + - business_name + - business_registration_identifier + - business_identity + - business_industry + - website_url + - business_regions_of_operation + - social_media_profile_urls + type: customer_profile_business_information + name: Business Information + requirement_name: customer_profile_business_information + - url: /EndUserTypes/authorized_representative_1 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_1 + name: Authorized Representative 1 + requirement_name: authorized_representative_1 + - url: /EndUserTypes/authorized_representative_2 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_2 + name: Authorized Representative 2 + requirement_name: authorized_representative_2 + supporting_trust_products: [] + supporting_document: + - - description: Customer Profile HQ Physical Address + type: document + name: Physical Business Address + accepted_documents: + - url: /SupportingDocumentTypes/customer_profile_address + fields: + - address_sids + type: customer_profile_address + name: Physical Business Address + requirement_name: customer_profile_address + supporting_customer_profiles: [] + friendly_name: Primary Customer Profile of type Business + sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListPolicies - x-maturity: - - GA /v1/Policies/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - pathType: instance className: policies + pathType: instance get: description: Fetch specific Policy Instance. parameters: @@ -1945,16 +2999,133 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.policies' + examples: + fetch: + value: + url: https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + requirements: + end_user: + - url: /EndUserTypes/customer_profile_business_information + fields: + - business_type + - business_registration_number + - business_name + - business_registration_identifier + - business_identity + - business_industry + - website_url + - business_regions_of_operation + - social_media_profile_urls + type: customer_profile_business_information + name: Business Information + requirement_name: customer_profile_business_information + - url: /EndUserTypes/authorized_representative_1 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_1 + name: Authorized Representative 1 + requirement_name: authorized_representative_1 + - url: /EndUserTypes/authorized_representative_2 + fields: + - first_name + - last_name + - email + - phone_number + - business_title + - job_position + type: authorized_representative_2 + name: Authorized Representative 2 + requirement_name: authorized_representative_2 + supporting_trust_products: [] + supporting_document: + - - description: Customer Profile HQ Physical Address + type: document + name: Physical Business Address + accepted_documents: + - url: /SupportingDocumentTypes/customer_profile_address + fields: + - address_sids + type: customer_profile_address + name: Physical Business Address + requirement_name: customer_profile_address + supporting_customer_profiles: [] + friendly_name: Primary Customer Profile of type Business + sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchStarterCustomerProfilePolicy: + value: + url: https://trusthub.twilio.com/v1/Policies/RN806dd6cd175f314e1f96a9727ee271f4 + requirements: + end_user: + - url: /EndUserTypes/starter_customer_profile_information + fields: + - first_name + - last_name + - email + - phone_number + type: starter_customer_profile_information + name: Information + requirement_name: starter_customer_profile_information + supporting_trust_products: [] + supporting_document: + - - description: Customer Profile Address + type: document + name: Customer Profile Address + accepted_documents: + - url: /SupportingDocumentTypes/customer_profile_address + fields: + - address_sids + type: customer_profile_address + name: Legal Company Address + - url: /SupportingDocumentTypes/starter_customer_profile_address + fields: + - address_sids + type: starter_customer_profile_address + name: Legal Company Address + requirement_name: customer_profile_address + supporting_customer_profiles: + - type: primary_customer_profile_type_business + name: Primary Customer Profile Bundle + requirement_name: primary_customer_profile + friendly_name: Starter Customer Profile of type Business + sid: RN806dd6cd175f314e1f96a9727ee271f4 + fetchSoleProprietorTrustBundlePolicy: + value: + url: https://trusthub.twilio.com/v1/Policies/RN670d5d2e282a6130ae063b234b6019c8 + requirements: + end_user: + - url: /EndUserTypes/sole_proprietor_information + fields: + - brand_name + - mobile_phone_number + - vertical + type: sole_proprietor_information + name: Sole Proprietor Information + requirement_name: sole_proprietor_information + supporting_trust_products: [] + supporting_document: + - [] + supporting_customer_profiles: + - type: starter_customer_profile_type_business + name: Starter Customer Profile(isv customers) Proof + requirement_name: customer_profile + - type: starter_customer_profile_type_direct_long_tail + name: Starter Customer Profile(direct customers) Proof + requirement_name: customer_profile + friendly_name: Sole Proprietor TrustProduct + sid: RN670d5d2e282a6130ae063b234b6019c8 description: OK security: - accountSid_authToken: [] operationId: FetchPolicies - x-maturity: - - GA /v1/SupportingDocuments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1968,12 +3139,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' + examples: + create: + value: + status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: Business-profile-physical-address + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null description: Created security: - accountSid_authToken: [] operationId: CreateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1994,6 +3177,12 @@ paths: required: - FriendlyName - Type + examples: + create: + value: + FriendlyName: Business-profile-physical-address + Type: customer_profile_address + Attributes: '{}' get: description: Retrieve a list of all Supporting Document for an account. parameters: @@ -2029,38 +3218,70 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.supporting_document' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: Business-profile-physical-address + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocument - x-maturity: - - GA /v1/SupportingDocuments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2085,12 +3306,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' + examples: + fetch: + value: + status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: Business-profile-physical-address + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocument - x-maturity: - - GA post: description: Update an existing Supporting Document. parameters: @@ -2110,12 +3343,24 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' + examples: + update: + value: + status: draft + date_updated: '2021-02-11T17:23:00Z' + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2021-02-11T17:23:00Z' + sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + attributes: + address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: customer_profile_address + mime_type: null description: OK security: - accountSid_authToken: [] operationId: UpdateSupportingDocument - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2130,6 +3375,11 @@ paths: description: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types. + examples: + update: + value: + FriendlyName: friendly_name + Attributes: '{}' delete: description: Delete a specific Supporting Document. parameters: @@ -2149,12 +3399,10 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSupportingDocument - x-maturity: - - GA /v1/SupportingDocumentTypes: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2195,38 +3443,82 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.supporting_document_type' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + supporting_document_types: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types + readFull: + value: + supporting_document_types: + - url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: address_sids + friendly_name: Address Sids + constraint: List + machine_name: customer_profile_address + friendly_name: Customer profile address + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: business_name + friendly_name: Business Name + constraint: String + machine_name: government_issued_proof_of_authorized_representative + friendly_name: Government Issued Identity certifying proof of + being an authorized representative of a company + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 + next_page_url: null + key: supporting_document_types description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocumentType - x-maturity: - - GA /v1/SupportingDocumentTypes/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -2248,27 +3540,43 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document_type' + examples: + fetch: + value: + url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fields: + - machine_name: first_name + friendly_name: First Name + constraint: String + - machine_name: last_name + friendly_name: Last Name + constraint: String + - machine_name: business_name + friendly_name: Business Name + constraint: String + machine_name: government_issued_proof_of_authorized_representative + friendly_name: Government Issued Identity certifying proof of + being an authorized representative of a company + sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocumentType - x-maturity: - - GA /v1/TrustProducts: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: list dependentProperties: trust_products_entity_assignments: '{trust_product_sid: sid}' trust_products_evaluations: '{trust_product_sid: sid}' trust_products_channel_endpoint_assignment: '{trust_product_sid: sid}' className: trust_products + pathType: list post: description: Create a new Customer-Profile. responses: @@ -2277,12 +3585,28 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' + examples: + create: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: Created security: - accountSid_authToken: [] operationId: CreateTrustProduct - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2313,6 +3637,13 @@ paths: - FriendlyName - Email - PolicySid + examples: + create: + value: + FriendlyName: friendly_name + Email: email + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + StatusCallback: http://www.example.com get: description: Retrieve a list of all Customer-Profiles for an account. parameters: @@ -2322,11 +3653,17 @@ paths: schema: type: string $ref: '#/components/schemas/trust_product_enum_status' + examples: + readFull: + value: draft - name: FriendlyName in: query description: The string that you assigned to describe the resource. schema: type: string + examples: + readFull: + value: friendly_name - name: PolicySid in: query description: The unique string of a policy that is associated to the Customer-Profile @@ -2336,6 +3673,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ + examples: + readFull: + value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2368,49 +3708,85 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: provisionally-approved + email: email + status_callback: http://www.example.com + valid_until: '2020-07-31T01:00:00Z' + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProduct - x-maturity: - - GA /v1/TrustProducts/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name - pathType: instance dependentProperties: trust_products_entity_assignments: '{trust_product_sid: sid}' trust_products_evaluations: '{trust_product_sid: sid}' trust_products_channel_endpoint_assignment: '{trust_product_sid: sid}' className: trust_products + pathType: instance get: description: Fetch a specific Customer-Profile instance. parameters: @@ -2430,12 +3806,28 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' + examples: + fetch: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + valid_until: null + email: email + status_callback: http://www.example.com + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: FetchTrustProduct - x-maturity: - - GA post: description: Updates a Customer-Profile in an account. parameters: @@ -2455,12 +3847,45 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' + examples: + update: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: draft + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments + updateToInReview: + value: + sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + status: in-review + email: email + status_callback: http://www.example.com + valid_until: null + date_created: '2019-07-30T22:29:24Z' + date_updated: '2019-07-31T01:09:00Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments + trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations + trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments description: OK security: - accountSid_authToken: [] operationId: UpdateTrustProduct - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2484,6 +3909,16 @@ paths: type: string description: The email address that will receive updates when the Customer-Profile resource changes status. + examples: + update: + value: + Status: draft + StatusCallback: http://www.example.com + FriendlyName: friendly_name + Email: email + updateToInReview: + value: + Status: pending-review delete: description: Delete a specific Customer-Profile. parameters: @@ -2503,18 +3938,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrustProduct - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /TrustProducts/{Sid} mountName: trust_products_channel_endpoint_assignment + pathType: list post: description: Create a new Assigned Item. parameters: @@ -2534,12 +3967,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' + examples: + create: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductChannelEndpointAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2559,6 +4000,11 @@ paths: required: - ChannelEndpointType - ChannelEndpointSid + examples: + create: + value: + ChannelEndpointSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ChannelEndpointType: phone-number get: description: Retrieve a list of all Assigned Items for an account. parameters: @@ -2580,6 +4026,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readFull: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: ChannelEndpointSids in: query description: comma separated list of channel endpoint sids @@ -2617,44 +4066,72 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProductChannelEndpointAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /TrustProducts/{Sid} mountName: trust_products_channel_endpoint_assignment + pathType: instance get: description: Fetch specific Assigned Item Instance. parameters: @@ -2683,12 +4160,20 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' + examples: + fetch: + value: + sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + channel_endpoint_type: phone-number + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductChannelEndpointAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. parameters: @@ -2717,19 +4202,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrustProductChannelEndpointAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/EntityAssignments: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /TrustProducts/{Sid} mountName: trust_products_entity_assignments className: trust_products_entity_assignments + pathType: list post: description: Create a new Assigned Item. parameters: @@ -2749,12 +4232,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' + examples: + create: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductEntityAssignment - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2771,6 +4261,10 @@ paths: the different items. required: - ObjectSid + examples: + create: + value: + ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. parameters: @@ -2816,45 +4310,72 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProductEntityAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /TrustProducts/{Sid} mountName: trust_products_entity_assignments className: trust_products_entity_assignments + pathType: instance get: description: Fetch specific Assigned Item Instance. parameters: @@ -2883,12 +4404,19 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' + examples: + fetch: + value: + sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2019-07-31T02:34:41Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductEntityAssignment - x-maturity: - - GA delete: description: Remove an Assignment Item Instance. parameters: @@ -2917,19 +4445,17 @@ paths: security: - accountSid_authToken: [] operationId: DeleteTrustProductEntityAssignment - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/Evaluations: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: list parent: /TrustProducts/{Sid} mountName: trust_products_evaluations className: trust_products_evaluations + pathType: list post: description: Create a new Evaluation parameters: @@ -2949,12 +4475,213 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' + examples: + create: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + createCompliantSoleProprietorA2PProfile: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: compliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - valid: + - object_field: brand_name + error_code: null + friendly_name: Brand Name + passed: true + failure_reason: null + - object_field: mobile_phone_number + error_code: null + friendly_name: Mobile Phone Number + passed: true + failure_reason: null + - object_field: vertical + error_code: null + friendly_name: Vertical + passed: true + failure_reason: null + invalid: [] + object_type: sole_proprietor_information + friendly_name: Sole Proprietor Information + failure_reason: null + passed: true + requirement_friendly_name: Sole Proprietor Information + error_code: null + requirement_name: sole_proprietor_information + - valid: + - object_field: bundle_status + error_code: null + friendly_name: Supporting Bundle Status + passed: true + failure_reason: null + invalid: [] + object_type: starter_customer_profile_type_business + friendly_name: Starter Customer Profile(isv customers) Proof + failure_reason: null + passed: true + requirement_friendly_name: Customer Profile + error_code: null + requirement_name: customer_profile description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductEvaluation - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2971,6 +4698,13 @@ paths: the customer_profile resource. required: - PolicySid + examples: + create: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCompliantSoleProprietorA2PProfile: + value: + PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Evaluations associated to the trust_product resource. @@ -3017,45 +4751,218 @@ paths: items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + results: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results + readFull: + value: + results: + - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add + one to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the + Business information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter + in a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure + both Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in + the address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please + add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info + meta: + page: 0 + page_size: 50 + first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + previous_page_url: null + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 + next_page_url: null + key: results description: OK security: - accountSid_authToken: [] operationId: ListTrustProductEvaluation - x-maturity: - - GA /v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}: servers: - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - pathType: instance parent: /TrustProducts/{Sid} mountName: trust_products_evaluations className: trust_products_evaluations + pathType: instance get: description: Fetch specific Evaluation Instance. parameters: @@ -3084,14 +4991,164 @@ paths: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' + examples: + fetch: + value: + sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: noncompliant + date_created: '2020-04-28T18:14:01Z' + url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + results: + - friendly_name: Business + object_type: business + passed: false + failure_reason: A Business End-User is missing. Please add one + to the regulatory bundle. + error_code: 22214 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Please enter + in a Business Name on the Business information. + error_code: 22215 + - friendly_name: Business Registration Number + object_field: business_registration_number + failure_reason: The Business Registration Number is missing. + Please enter in a Business Registration Number on the Business + information. + error_code: 22215 + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Please enter in + a First Name on the Business information. + error_code: 22215 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Please enter in + a Last Name on the Business information. + error_code: 22215 + requirement_friendly_name: Business + requirement_name: business_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) showing name of Authorized Representative is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Business Name + object_field: business_name + failure_reason: The Business Name is missing. Or, it does + not match the Business Name you entered within Business + information. Please enter in the Business Name shown on + the Excerpt from the commercial register (Extrait K-bis) + showing name of Authorized Representative or make sure both + Business Name fields use the same exact inputs. + error_code: 22217 + requirement_friendly_name: Business Name + requirement_name: business_name_info + - friendly_name: Excerpt from the commercial register showing + French address + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register showing + French address is missing. Please add one to the regulatory + bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Address sid(s) + object_field: address_sids + failure_reason: The Address is missing. Please enter in the + address shown on the Excerpt from the commercial register + showing French address. + error_code: 22219 + requirement_friendly_name: Business Address (Proof of Address) + requirement_name: business_address_proof_info + - friendly_name: Excerpt from the commercial register (Extrait + K-bis) + object_type: commercial_registrar_excerpt + passed: false + failure_reason: An Excerpt from the commercial register (Extrait + K-bis) is missing. Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: Document Number + object_field: document_number + failure_reason: The Document Number is missing. Please enter + in the Document Number shown on the Excerpt from the commercial + register (Extrait K-bis). + error_code: 22217 + requirement_friendly_name: Business Registration Number + requirement_name: business_reg_no_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing. Or, it does not + match the First Name you entered within Business information. + Please enter in the First Name shown on the Government-issued + ID or make sure both First Name fields use the same exact + inputs. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing. Or, it does not + match the Last Name you entered within Business information. + Please enter in the Last Name shown on the Government-issued + ID or make sure both Last Name fields use the same exact + inputs. + error_code: 22217 + requirement_friendly_name: Name of Authorized Representative + requirement_name: name_of_auth_rep_info + - friendly_name: Executed Copy of Power of Attorney + object_type: power_of_attorney + passed: false + failure_reason: An Executed Copy of Power of Attorney is missing. + Please add one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: [] + requirement_friendly_name: Power of Attorney + requirement_name: power_of_attorney_info + - friendly_name: Government-issued ID + object_type: government_issued_document + passed: false + failure_reason: A Government-issued ID is missing. Please add + one to the regulatory bundle. + error_code: 22216 + valid: [] + invalid: + - friendly_name: First Name + object_field: first_name + failure_reason: The First Name is missing on the Governnment-Issued + ID. + error_code: 22217 + - friendly_name: Last Name + object_field: last_name + failure_reason: The Last Name is missing on the Government-issued + ID + error_code: 22217 + requirement_friendly_name: Name of Person granted the Power + of Attorney + requirement_name: name_in_power_of_attorney_info description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductEvaluation - x-maturity: - - GA servers: - url: https://trusthub.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 1fdac2a7..5f48ff22 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: verify.v2.service.access_token: type: object @@ -1316,10 +1320,6 @@ components: enum: - GET - POST - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Verify description: This is the public Twilio REST API. @@ -1331,13 +1331,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/AccessTokens: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1349,8 +1349,8 @@ paths: - token - ttl - date_created - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new enrollment Access Token for the Entity parameters: @@ -1369,12 +1369,35 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' + examples: + createWithTtl: + value: + sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_identity: ff483d1ff591898a9942916050d2ca3f + factor_type: push + factor_friendly_name: John Doe iPhone + ttl: 300 + date_created: '2015-07-30T20:00:00Z' + token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithoutTtl: + value: + sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_identity: ff483d1ff591898a9942916050d2ca3f + factor_type: push + factor_friendly_name: John Doe iPhone + ttl: 60 + date_created: '2015-07-30T20:00:00Z' + token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateAccessToken - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1402,10 +1425,22 @@ paths: required: - Identity - FactorType + examples: + createWithTtl: + value: + FactorType: push + FactorFriendlyName: John Doe iPhone + Identity: ff483d1ff591898a9942916050d2ca3f + Ttl: 300 + createWithoutTtl: + value: + FactorType: push + FactorFriendlyName: John Doe iPhone + Identity: ff483d1ff591898a9942916050d2ca3f /v2/Services/{ServiceSid}/AccessTokens/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1417,8 +1452,8 @@ paths: - token - ttl - date_created - pathType: instance parent: /Services/{Sid} + pathType: instance get: description: Fetch an Access Token for the Entity parameters: @@ -1446,16 +1481,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' + examples: + fetch: + value: + sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_identity: ff483d1ff591898a9942916050d2ca3f + factor_type: push + factor_friendly_name: John Doe iPhone + ttl: 60 + date_created: '2015-07-30T20:00:00Z' + token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchAccessToken - x-maturity: - - GA /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1466,8 +1512,8 @@ paths: - interval - date_created - date_updated - pathType: list parent: /Services/{ServiceSid}/RateLimits/{Sid} + pathType: list post: description: Create a new Bucket for a Rate Limit parameters: @@ -1497,12 +1543,22 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' + examples: + createBucket: + value: + sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateBucket - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1521,6 +1577,11 @@ paths: required: - Max - Interval + examples: + createBucket: + value: + Max: 5 + Interval: 60 get: description: Retrieve a list of all Buckets for a Rate Limit. parameters: @@ -1576,38 +1637,68 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + buckets: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + next_page_url: null + key: buckets + readFull: + value: + buckets: + - sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 + next_page_url: null + key: buckets description: OK security: - accountSid_authToken: [] operationId: ListBucket - x-maturity: - - GA /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -1618,8 +1709,8 @@ paths: - interval - date_created - date_updated - pathType: instance parent: /Services/{ServiceSid}/RateLimits/{Sid} + pathType: instance post: description: Update a specific Bucket. parameters: @@ -1658,12 +1749,22 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' + examples: + updateBucket: + value: + sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateBucket - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1679,6 +1780,11 @@ paths: type: integer description: Number of seconds that the rate limit will be enforced over. + examples: + updateBucket: + value: + Max: 5 + Interval: 60 get: description: Fetch a specific Bucket. parameters: @@ -1717,12 +1823,22 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' + examples: + fetchBucket: + value: + sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max: 5 + interval: 60 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchBucket - x-maturity: - - GA delete: description: Delete a specific Bucket. parameters: @@ -1761,23 +1877,21 @@ paths: security: - accountSid_authToken: [] operationId: DeleteBucket - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created - pathType: list dependentProperties: notification: '{service_sid: service_sid, identity: identity, challenge_sid: sid}' parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: list post: description: Create a new Challenge for the Factor parameters: @@ -1805,12 +1919,92 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' + examples: + createPush: + value: + sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + createTotpWithoutAuthPayload: + value: + sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + createTotpWithAuthPayload: + value: + sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications description: Created security: - accountSid_authToken: [] operationId: CreateChallenge - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1857,6 +2051,32 @@ paths: be between 3 and 8 characters long. required: - FactorSid + examples: + createPush: + value: + FactorSid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ExpirationDate: '2015-07-30T20:00:00Z' + Details.Message: Hi! Mr. John Doe, would you like to sign up? + Details.Fields: + - '{"label": "Action", "value": "Sign up in portal"}' + HiddenDetails: '{"ip": "172.168.1.234"}' + createTotpWithoutAuthPayload: + value: + FactorSid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ExpirationDate: '2015-07-30T20:00:00Z' + Details.Message: Hi! Mr. John Doe, would you like to sign up? + Details.Fields: + - '{"label": "Action", "value": "Sign up in portal"}' + HiddenDetails: '{"ip": "172.168.1.234"}' + createTotpWithAuthPayload: + value: + FactorSid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ExpirationDate: '2015-07-30T20:00:00Z' + Details.Message: Hi! Mr. John Doe, would you like to sign up? + Details.Fields: + - '{"label": "Action", "value": "Sign up in portal"}' + HiddenDetails: '{"ip": "172.168.1.234"}' + AuthPayload: '12345678' get: description: Retrieve a list of all Challenges for a Factor. parameters: @@ -1932,49 +2152,120 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.entity.challenge' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + challenges: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + next_page_url: null + key: challenges + readFull: + value: + challenges: + - sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + - sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: pending + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 + next_page_url: null + key: challenges description: OK security: - accountSid_authToken: [] operationId: ListChallenge - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created - pathType: instance dependentProperties: notification: '{service_sid: service_sid, identity: identity, challenge_sid: sid}' parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: instance get: description: Fetch a specific Challenge. parameters: @@ -2011,12 +2302,39 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' + examples: + fetchSid: + value: + sid: YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: + os: Android + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications description: OK security: - accountSid_authToken: [] operationId: FetchChallenge - x-maturity: - - GA post: description: Verify a specific Challenge. parameters: @@ -2053,12 +2371,66 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' + examples: + verifyPush: + value: + sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: + os: Android + factor_type: push + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications + verifyTotp: + value: + sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + date_responded: '2015-07-30T20:00:00Z' + expiration_date: '2015-07-30T20:00:00Z' + status: approved + responded_reason: none + details: + message: Hi! Mr. John Doe, would you like to sign up? + date: '2020-07-01T12:13:14Z' + fields: + - label: Action + value: Sign up in portal + hidden_details: + ip: 172.168.1.234 + metadata: null + factor_type: totp + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications description: OK security: - accountSid_authToken: [] operationId: UpdateChallenge - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2078,21 +2450,29 @@ paths: of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' + examples: + verifyPush: + value: + AuthPayload: '123456' + Metadata: '{"os": "Android"}' + verifyTotp: + value: + AuthPayload: '123456' /v2/Services/{ServiceSid}/Entities: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: list dependentProperties: factor: '{service_sid: service_sid, identity: identity}' new_factor: '{service_sid: service_sid, identity: identity}' challenge: '{service_sid: service_sid, identity: identity}' parent: /Services/{Sid} + pathType: list post: description: Create a new Entity for the Service parameters: @@ -2111,12 +2491,24 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' + examples: + create: + value: + sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f + links: + factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges description: Created security: - accountSid_authToken: [] operationId: CreateEntity - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2133,6 +2525,10 @@ paths: (-) separated alphanumeric characters. required: - Identity + examples: + create: + value: + Identity: ff483d1ff591898a9942916050d2ca3f get: description: Retrieve a list of all Entities for a Service. parameters: @@ -2177,49 +2573,81 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.entity' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + entities: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + next_page_url: null + key: entities + readFull: + value: + entities: + - sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f + links: + factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 + next_page_url: null + key: entities description: OK security: - accountSid_authToken: [] operationId: ListEntity - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created - pathType: instance dependentProperties: factor: '{service_sid: service_sid, identity: identity}' new_factor: '{service_sid: service_sid, identity: identity}' challenge: '{service_sid: service_sid, identity: identity}' parent: /Services/{Sid} + pathType: instance delete: description: Delete a specific Entity. parameters: @@ -2247,8 +2675,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteEntity - x-maturity: - - GA get: description: Fetch a specific Entity. parameters: @@ -2276,24 +2702,36 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' + examples: + fetch: + value: + sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f + links: + factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors + challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges description: OK security: - accountSid_authToken: [] operationId: FetchEntity - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type - pathType: instance parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: instance delete: description: Delete a specific Factor. parameters: @@ -2330,8 +2768,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteFactor - x-maturity: - - GA get: description: Fetch a specific Factor. parameters: @@ -2368,12 +2804,50 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' + examples: + fetchPush: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchTotp: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchFactor - x-maturity: - - GA post: description: Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param. @@ -2411,12 +2885,50 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' + examples: + verifyPush: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: verified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verifyTotp: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: verified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateFactor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2466,18 +2978,29 @@ paths: Required when `factor_type` is `push`.' + examples: + verifyPush: + value: + AuthPayload: '123456' + FriendlyName: FriendlyName + Config.SdkVersion: '1.0' + Config.NotificationToken: test_token + verifyTotp: + value: + FriendlyName: My Friendly Name + AuthPayload: '123456' /v2/Services/{ServiceSid}/Entities/{Identity}/Factors: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type - pathType: list parent: /Services/{ServiceSid}/Entities/{Identity} + pathType: list get: description: Retrieve a list of all Factors for an Entity. parameters: @@ -2531,34 +3054,101 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.entity.factor' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + factors: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + next_page_url: null + key: factors + readFullPush: + value: + factors: + - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + next_page_url: null + key: factors + readFullTotp: + value: + factors: + - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 + next_page_url: null + key: factors description: OK security: - accountSid_authToken: [] operationId: ListFactor - x-maturity: - - GA post: description: Create a new Factor for the Entity parameters: @@ -2586,12 +3176,56 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.new_factor' + examples: + createPush: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + binding: + alg: ES256 + public_key: MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8GdwtibWe0kpgsFl6xPQBwhtwUEyeJkeozFmi2jiJDzxFSMwVy3kVR1h/dPVYOfgkC0EkfBRJ0J/6xW47FD5vA== + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: push + config: + sdk_version: '1.0' + app_id: com.example.myapp + notification_platform: fcm + notification_token: test_token + metadata: + os: Android + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createTotp: + value: + sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + binding: + secret: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ + uri: otpauth://totp/test-issuer:John%E2%80%99s%20Account%20Name?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=test-issuer&algorithm=SHA1&digits=6&period=30 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + status: unverified + factor_type: totp + config: + alg: sha1 + skew: 1 + code_length: 6 + time_step: 30 + metadata: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateNewFactor - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2708,12 +3342,33 @@ paths: required: - FriendlyName - FactorType + examples: + createPush: + value: + FactorType: push + FriendlyName: FriendlyName + Binding.Alg: ES256 + Binding.PublicKey: dGVzdF9rZXk= + Config.SdkVersion: '1.0' + Config.AppId: com.example.myapp + Config.NotificationPlatform: fcm + Config.NotificationToken: test_token + Metadata: '{"os": "Android"}' + createTotp: + value: + FactorType: totp + FriendlyName: FriendlyName + Binding.Secret: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ + Config.Alg: sha1 + Config.TimeStep: 30 + Config.CodeLength: 6 + Config.Skew: 1 x-twilio: mountName: new_factors /v2/Forms/{FormType}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - form_type @@ -2734,16 +3389,24 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.form' + examples: + fetch: + value: + form_type: form-push + forms: + create_factor: {} + verify_factor: {} + create_challenge: {} + form_meta: {} + url: https://verify.twilio.com/v2/Forms/form-push description: OK security: - accountSid_authToken: [] operationId: FetchForm - x-maturity: - - Beta /v2/Services/{ServiceSid}/MessagingConfigurations: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid @@ -2752,8 +3415,8 @@ paths: - messaging_service_sid - date_created - date_updated - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new MessagingConfiguration for a service. parameters: @@ -2773,12 +3436,20 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA description: Created security: - accountSid_authToken: [] operationId: CreateMessagingConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2802,6 +3473,11 @@ paths: required: - Country - MessagingServiceSid + examples: + create: + value: + Country: CA + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Messaging Configurations for a Service. parameters: @@ -2847,38 +3523,66 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + messaging_configurations: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + next_page_url: null + key: messaging_configurations + readFull: + value: + messaging_configurations: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 + next_page_url: null + key: messaging_configurations description: OK security: - accountSid_authToken: [] operationId: ListMessagingConfiguration - x-maturity: - - GA /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - account_sid @@ -2887,8 +3591,8 @@ paths: - messaging_service_sid - date_created - date_updated - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: Update a specific MessagingConfiguration parameters: @@ -2916,12 +3620,20 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA description: OK security: - accountSid_authToken: [] operationId: UpdateMessagingConfiguration - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2938,6 +3650,10 @@ paths: to be used to send SMS to the country of this configuration. required: - MessagingServiceSid + examples: + update: + value: + MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Fetch a specific MessagingConfiguration. parameters: @@ -2965,12 +3681,20 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + country: CA + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA description: OK security: - accountSid_authToken: [] operationId: FetchMessagingConfiguration - x-maturity: - - GA delete: description: Delete a specific MessagingConfiguration. parameters: @@ -2998,20 +3722,18 @@ paths: security: - accountSid_authToken: [] operationId: DeleteMessagingConfiguration - x-maturity: - - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - challenge_sid - date_created - pathType: list parent: /Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid} + pathType: list post: description: Create a new Notification for the corresponding Challenge parameters: @@ -3048,12 +3770,33 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge.notification' + examples: + createWithTtl: + value: + sid: NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + challenge_sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + priority: high + ttl: 150 + createWithoutTtl: + value: + sid: NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: ff483d1ff591898a9942916050d2ca3f + challenge_sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + priority: high + ttl: 300 description: Created security: - accountSid_authToken: [] operationId: CreateNotification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3068,10 +3811,16 @@ paths: until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. + examples: + createWithTtl: + value: + Ttl: 150 + createWithoutTtl: + value: {} /v2/Services/{ServiceSid}/RateLimits: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3081,10 +3830,10 @@ paths: - description - date_created - date_updated - pathType: list dependentProperties: bucket: '{service_sid: service_sid, rate_limit_sid: sid}' parent: /Services/{Sid} + pathType: list post: description: Create a new Rate Limit for a Service parameters: @@ -3104,12 +3853,23 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' + examples: + createRateLimit: + value: + sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: Created security: - accountSid_authToken: [] operationId: CreateRateLimit - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3127,6 +3887,11 @@ paths: description: Description of this Rate Limit required: - UniqueName + examples: + createRateLimit: + value: + UniqueName: unique.name + Description: Description get: description: Retrieve a list of all Rate Limits for a service. parameters: @@ -3172,38 +3937,58 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.rate_limit' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: rate_limits + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0 + rate_limits: + - sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: OK security: - accountSid_authToken: [] operationId: ListRateLimit - x-maturity: - - GA /v2/Services/{ServiceSid}/RateLimits/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3213,10 +3998,10 @@ paths: - description - date_created - date_updated - pathType: instance dependentProperties: bucket: '{service_sid: service_sid, rate_limit_sid: sid}' parent: /Services/{Sid} + pathType: instance post: description: Update a specific Rate Limit. parameters: @@ -3246,12 +4031,23 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' + examples: + updateRateLimit: + value: + sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: OK security: - accountSid_authToken: [] operationId: UpdateRateLimit - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3262,6 +4058,10 @@ paths: Description: type: string description: Description of this Rate Limit + examples: + updateRateLimit: + value: + Description: Description get: description: Fetch a specific Rate Limit. parameters: @@ -3291,12 +4091,23 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' + examples: + fetchRateLimit: + value: + sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique.name + description: Description + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets description: OK security: - accountSid_authToken: [] operationId: FetchRateLimit - x-maturity: - - GA delete: description: Delete a specific Rate Limit. parameters: @@ -3326,18 +4137,16 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRateLimit - x-maturity: - - GA /v2/SafeList/Numbers: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - phone_number - pathType: list mountName: safelist + pathType: list post: description: Add a new phone number to SafeList. responses: @@ -3346,12 +4155,16 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.safelist' + examples: + create: + value: + sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+18001234567' + url: https://verify.twilio.com/v2/SafeList/Numbers/+18001234567 description: Created security: - accountSid_authToken: [] operationId: CreateSafelist - x-maturity: - - Beta requestBody: content: application/x-www-form-urlencoded: @@ -3365,16 +4178,20 @@ paths: must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). required: - PhoneNumber + examples: + create: + value: + PhoneNumber: '+18001234567' /v2/SafeList/Numbers/{PhoneNumber}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - phone_number - pathType: instance mountName: safelist + pathType: instance get: description: Check if a phone number exists in SafeList. parameters: @@ -3391,12 +4208,16 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.safelist' + examples: + fetch: + value: + sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + phone_number: '+18001234567' + url: https://verify.twilio.com/v2/SafeList/Numbers/+18001234567 description: OK security: - accountSid_authToken: [] operationId: FetchSafelist - x-maturity: - - Beta delete: description: Remove a phone number from SafeList. parameters: @@ -3413,18 +4234,15 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSafelist - x-maturity: - - Beta /v2/Services: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: list dependentProperties: verification: '{service_sid: sid}' verification_check: '{service_sid: sid}' @@ -3433,6 +4251,7 @@ paths: entity: '{service_sid: sid}' webhook: '{service_sid: sid}' access_token: '{service_sid: sid}' + pathType: list post: description: Create a new Verification Service. responses: @@ -3441,12 +4260,46 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service' + examples: + createRecord: + value: + sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fcm_credential_sid: null + totp: + issuer: test-issuer + time_step: 30 + code_length: 3 + skew: 2 + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck + verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications + rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits + messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations + entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities + webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens description: Created security: - accountSid_authToken: [] operationId: CreateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3553,6 +4406,25 @@ paths: SMS channel only. required: - FriendlyName + examples: + createRecord: + value: + FriendlyName: name + CodeLength: 4 + LookupEnabled: false + Psd2Enabled: false + SkipSmsToLandlines: false + DtmfInputRequired: false + TtsName: name + MailerSid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DoNotShareWarningEnabled: false + CustomCodeEnabled: true + Push.ApnCredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Totp.Issuer: test-issuer + Totp.TimeStep: 30 + Totp.CodeLength: 3 + Totp.Skew: 2 + DefaultTemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Verification Services for an account. parameters: @@ -3588,44 +4460,86 @@ paths: items: $ref: '#/components/schemas/verify.v2.service' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readAll: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services?PageSize=50&Page=0 + previous_page_url: null + next_page_url: null + key: services + url: https://verify.twilio.com/v2/Services?PageSize=50&Page=0 + services: + - sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: null + fcm_credential_sid: null + totp: + issuer: null + time_step: null + code_length: null + skew: null + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck + verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications + rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits + messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations + entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities + webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens description: OK security: - accountSid_authToken: [] operationId: ListService - x-maturity: - - GA /v2/Services/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created - pathType: instance dependentProperties: verification: '{service_sid: sid}' verification_check: '{service_sid: sid}' @@ -3634,6 +4548,7 @@ paths: entity: '{service_sid: sid}' webhook: '{service_sid: sid}' access_token: '{service_sid: sid}' + pathType: instance get: description: Fetch specific Verification Service Instance. parameters: @@ -3653,12 +4568,46 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service' + examples: + fetchRecord: + value: + sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: null + fcm_credential_sid: null + totp: + issuer: null + time_step: null + code_length: null + skew: null + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck + verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications + rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits + messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations + entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities + webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens description: OK security: - accountSid_authToken: [] operationId: FetchService - x-maturity: - - GA delete: description: Delete a specific Verification Service Instance. parameters: @@ -3678,8 +4627,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteService - x-maturity: - - GA post: description: Update a specific Verification Service. parameters: @@ -3699,12 +4646,46 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service' + examples: + updateRecord: + value: + sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + code_length: 4 + lookup_enabled: false + psd2_enabled: false + skip_sms_to_landlines: false + dtmf_input_required: false + tts_name: name + mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + do_not_share_warning_enabled: false + custom_code_enabled: true + push: + include_date: false + apn_credential_sid: null + fcm_credential_sid: CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + totp: + issuer: test-issuer + time_step: 30 + code_length: 3 + skew: 2 + default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck + verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications + rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits + messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations + entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities + webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks + access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens description: OK security: - accountSid_authToken: [] operationId: UpdateService - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3803,10 +4784,30 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. + examples: + updateRecord: + value: + FriendlyName: name + CodeLength: 4 + LookupEnabled: false + Psd2Enabled: false + SkipSmsToLandlines: false + DtmfInputRequired: false + TtsName: name + MailerSid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + DoNotShareWarningEnabled: false + CustomCodeEnabled: true + Push.IncludeDate: false + Push.FcmCredentialSid: CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + Totp.Issuer: test-issuer + Totp.TimeStep: 30 + Totp.CodeLength: 3 + Totp.Skew: 2 + DefaultTemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v2/Services/{ServiceSid}/Verifications: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3815,8 +4816,8 @@ paths: - status - valid - date_created - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new Verification using a Service parameters: @@ -3836,12 +4837,145 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' + examples: + createVerification: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationWhatsapp: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: whatsapp + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: whatsapp + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationEmail: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: mail@email.com + channel: email + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: EMAIL + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationWithRateLimits: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationSna: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sna + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: + carrier: + mobile_country_code: '311' + type: mobile + error_code: null + mobile_network_code: '180' + name: T-Mobile USA, Inc. + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: sna + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: + url: https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createVerificationAuto: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sna + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: + carrier: + mobile_country_code: '311' + type: mobile + error_code: null + mobile_network_code: '180' + name: T-Mobile USA, Inc. + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: sna + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: + url: https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateVerification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3928,10 +5062,62 @@ paths: required: - To - Channel + examples: + createVerification: + value: + To: '+15017122661' + Channel: sms + CustomCode: custom_code + CustomFriendlyName: custom_friendly_name + CustomMessage: custom_message + SendDigits: ww1 + Locale: en + Amount: "\u20AC39.99" + Payee: Acme Inc. + AppHash: AAAAAAAAAAA + TemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + TemplateCustomSubstitutions: '{"AppName": "MyApp", "Contact":"12345689"}' + createVerificationWhatsapp: + value: + To: '+15017122661' + Channel: whatsapp + CustomCode: custom_code + CustomFriendlyName: custom_friendly_name + Locale: en + createVerificationEmail: + value: + To: mail@email.com + Channel: email + CustomCode: custom_code + CustomMessage: custom_message + Locale: en + Amount: "\u20AC39.99" + Payee: Acme Inc. + ChannelConfiguration: '{"from": "foo@bar.com", "from_name": "Bar + Inc.", "substitutions": { "username": "ms. baz" }, "template_id": + "Dxxxxxxxxxx"}' + createVerificationWithRateLimits: + value: + To: '+15017122661' + Channel: sms + CustomCode: custom_code + CustomMessage: custom_message + SendDigits: ww1 + Locale: en + RateLimits: '{"my_rate_limit_key": "abc"}' + createVerificationSna: + value: + To: '+15017122661' + Channel: sna + createVerificationAuto: + value: + To: '+15017122661' + Channel: auto + DeviceIp: 0.000.00.000 /v2/Services/{ServiceSid}/Verifications/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -3940,8 +5126,8 @@ paths: - status - valid - date_created - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: Update a Verification status parameters: @@ -3968,12 +5154,51 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' + examples: + updateVerification: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: canceled + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + approveVerificationWithPn: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: approved + valid: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateVerification - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3988,6 +5213,13 @@ paths: or `approved`.' required: - Status + examples: + updateVerification: + value: + Status: canceled + approveVerificationWithPn: + value: + Status: approved get: description: Fetch a specific Verification parameters: @@ -4014,16 +5246,35 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' + examples: + fetchVerification: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: pending + valid: false + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + lookup: {} + amount: null + payee: null + send_code_attempts: + - time: '2015-07-30T20:00:00Z' + channel: SMS + attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sna: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchVerification - x-maturity: - - GA /v2/Attempts: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4031,8 +5282,8 @@ paths: - date_updated - conversion_status - channel - pathType: list mountName: verification_attempts + pathType: list get: description: List all the verification attempts for a given Account. parameters: @@ -4127,38 +5378,83 @@ paths: items: $ref: '#/components/schemas/verify.v2.verification_attempt' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + listVerificationAttemptsEmpty: + value: + attempts: [] + meta: + key: attempts + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + next_page_url: null + listVerificationAttempts: + value: + attempts: + - sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-08-11T18:36:59Z' + date_updated: '2020-08-11T18:37:00Z' + conversion_status: unconverted + channel: sms + price: + value: '0.005' + currency: usd + channel_data: + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+573003003030' + status: unconfirmed + message_status: undelivered + error_code: '30008' + country: CO + code_length: 6 + locale: es + mcc: '732' + mnc: '103' + carrier: Colombia Movil (Tigo) + url: https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + key: attempts + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 + next_page_url: null description: OK security: - accountSid_authToken: [] operationId: ListVerificationAttempt - x-maturity: - - GA /v2/Attempts/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4166,8 +5462,8 @@ paths: - date_updated - conversion_status - channel - pathType: instance mountName: verification_attempts + pathType: instance get: description: Fetch a specific verification attempt. parameters: @@ -4186,24 +5482,49 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.verification_attempt' + examples: + fetchVerificationAttempt: + value: + sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-08-11T18:36:59Z' + date_updated: '2020-08-11T18:37:00Z' + conversion_status: unconverted + channel: sms + price: + value: '0.005' + currency: usd + channel_data: + verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+573003003030' + status: unconfirmed + message_status: undelivered + error_code: '30008' + country: CO + code_length: 6 + locale: es + mcc: '732' + mnc: '103' + carrier: Colombia Movil (Tigo) + url: https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchVerificationAttempt - x-maturity: - - GA /v2/Attempts/Summary: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - total_attempts - total_converted - total_unconverted - conversion_rate_percentage - pathType: instance mountName: verification_attempts_summary + pathType: instance get: description: Get a summary of how many attempts were made and how many were converted. @@ -4217,6 +5538,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ + examples: + getAttemptsSummary: + value: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: DateCreatedAfter in: query description: Datetime filter used to consider only Verification Attempts created @@ -4225,6 +5549,9 @@ paths: schema: type: string format: date-time + examples: + getAttemptsSummary: + value: '2022-03-02T21:02:33Z' - name: DateCreatedBefore in: query description: Datetime filter used to consider only Verification Attempts created @@ -4233,6 +5560,9 @@ paths: schema: type: string format: date-time + examples: + getAttemptsSummary: + value: '2022-03-02T21:02:33Z' - name: Country in: query description: Filter used to consider only Verification Attempts sent to the @@ -4240,6 +5570,9 @@ paths: schema: type: string format: iso-country-code + examples: + getAttemptsSummary: + value: CO - name: Channel in: query description: Filter Verification Attempts considered on the summary aggregation @@ -4247,28 +5580,40 @@ paths: schema: type: string $ref: '#/components/schemas/verification_attempts_summary_enum_channels' + examples: + getAttemptsSummary: + value: sms - name: DestinationPrefix in: query description: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format. schema: type: string + examples: + getAttemptsSummary: + value: '+57305' responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.verification_attempts_summary' + examples: + getAttemptsSummary: + value: + total_attempts: 11 + total_converted: 9 + total_unconverted: 2 + conversion_rate_percentage: '81.818181818' + url: https://verify.twilio.com/v2/Attempts/Summary description: OK security: - accountSid_authToken: [] operationId: FetchVerificationAttemptsSummary - x-maturity: - - GA /v2/Services/{ServiceSid}/VerificationCheck: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4277,9 +5622,9 @@ paths: - status - valid - date_created - pathType: list parent: /Services/{Sid} mountName: verification_checks + pathType: list post: description: challenge a specific Verification Check. parameters: @@ -4299,12 +5644,55 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification_check' + examples: + verificationChecks: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sms + status: approved + valid: true + amount: null + payee: null + sna_attempts_error_codes: [] + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + emailVerificationChecks: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: recipient@foo.com + channel: email + status: approved + valid: true + amount: null + payee: null + sna_attempts_error_codes: [] + date_created: '2020-01-30T20:00:00Z' + date_updated: '2020-01-30T20:00:00Z' + snaVerificationChecks: + value: + sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + to: '+15017122661' + channel: sna + status: approved + valid: true + amount: null + payee: null + sna_attempts_error_codes: + - attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + code: 60001 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateVerificationCheck - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4336,10 +5724,26 @@ paths: type: string description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + examples: + verificationChecks: + value: + To: '+15017122661' + VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Code: '1234' + Amount: "\u20AC39.99" + Payee: Acme Inc. + emailVerificationChecks: + value: + To: recipient@foo.com + VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Code: '123456' + snaVerificationChecks: + value: + To: '+15017122661' /v2/Templates: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4385,38 +5789,77 @@ paths: items: $ref: '#/components/schemas/verify.v2.verification_template' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + listVerificationTemplates: + value: + templates: + - sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Base Verification Template 2 with do not share + channels: + - sms + translations: + en: + is_default_translation: true + status: approved + locale: en + text: 'Your {{friendly_name}} verification code is: {{code}}. + Do not share this code with anyone.' + date_updated: '2021-07-29T20:38:28.759979905Z' + date_created: '2021-07-29T20:38:28.165602325Z' + - sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Base Verification Template 3 + channels: + - sms + - voice + translations: + en: + is_default_translation: true + status: approved + locale: en + text: 'Your verification code is: {{code}}. Do not share + it.' + date_updated: '2021-07-29T20:38:28.759979905Z' + date_created: '2021-07-29T20:38:28.165602325Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Templates?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Templates?PageSize=50&Page=0 + next_page_url: null + key: templates description: OK security: - accountSid_authToken: [] operationId: ListVerificationTemplate - x-maturity: - - GA /v2/Services/{ServiceSid}/Webhooks: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4427,8 +5870,8 @@ paths: - webhook_method - status - date_created - pathType: list parent: /Services/{Sid} + pathType: list post: description: Create a new Webhook for the Service parameters: @@ -4447,12 +5890,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' + examples: + create: + value: + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: enabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: Created security: - accountSid_authToken: [] operationId: CreateWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4489,6 +5947,15 @@ paths: - FriendlyName - EventTypes - WebhookUrl + examples: + create: + value: + FriendlyName: name + EventTypes: + - factor.deleted + - factor.verified + WebhookUrl: https://owlbank.twilio.com + Version: v2 get: description: Retrieve a list of all Webhooks for a Service. parameters: @@ -4533,38 +6000,73 @@ paths: items: $ref: '#/components/schemas/verify.v2.service.webhook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + webhooks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + next_page_url: null + key: webhooks + readFull: + value: + webhooks: + - url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: enabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + meta: + page: 0 + page_size: 50 + first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + previous_page_url: null + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 + next_page_url: null + key: webhooks description: OK security: - accountSid_authToken: [] operationId: ListWebhook - x-maturity: - - GA /v2/Services/{ServiceSid}/Webhooks/{Sid}: servers: - url: https://verify.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid @@ -4575,8 +6077,8 @@ paths: - webhook_method - status - date_created - pathType: instance parent: /Services/{Sid} + pathType: instance post: description: '' parameters: @@ -4605,12 +6107,27 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' + examples: + update: + value: + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: disabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: UpdateWebhook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -4643,6 +6160,16 @@ paths: description: The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future. + examples: + update: + value: + FriendlyName: name + EventTypes: + - factor.deleted + - factor.verified + WebhookUrl: https://owlbank.twilio.com + Status: disabled + Version: v2 delete: description: Delete a specific Webhook. parameters: @@ -4671,8 +6198,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteWebhook - x-maturity: - - GA get: description: Fetch a specific Webhook. parameters: @@ -4701,17 +6226,26 @@ paths: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' + examples: + fetch: + value: + url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: name + event_types: + - factor.deleted + - factor.verified + webhook_method: POST + webhook_url: https://owlbank.twilio.com + status: enabled + version: v2 + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' description: OK security: - accountSid_authToken: [] operationId: FetchWebhook - x-maturity: - - GA servers: - url: https://verify.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index d19af828..d8934bcc 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: video.v1.composition: type: object @@ -1248,10 +1252,6 @@ components: nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Video description: This is the public Twilio REST API. @@ -1263,7 +1263,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Compositions/{Sid}: @@ -1276,9 +1276,9 @@ paths: - status - resolution - format - pathType: instance dependentProperties: - video/v1/composition_media: '{composition_sid: sid}' + media: '{composition_sid: sid}' + pathType: instance get: description: Returns a single Composition resource identified by a Composition SID. @@ -1298,12 +1298,66 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_completed: '2015-07-30T20:01:33Z' + date_deleted: null + sid: CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + audio_sources_excluded: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + video_layout: + grid: + video_sources: + - '*' + video_sources_excluded: + - MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + bitrate: 64 + size: 4 + duration: 6 + trim: true + media_external_location: null + encryption_key: null + url: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status_callback: https://mycallbackurl.com + status_callback_method: POST + links: + media: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchComposition - x-maturity: - - GA delete: description: Delete a Recording Composition resource identified by a Composition SID. @@ -1323,8 +1377,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteComposition - x-maturity: - - GA /v1/Compositions: servers: - url: https://video.twilio.com @@ -1335,9 +1387,9 @@ paths: - status - resolution - format - pathType: list dependentProperties: - video/v1/composition_media: '{composition_sid: sid}' + media: '{composition_sid: sid}' + pathType: list get: description: List of all Recording compositions. parameters: @@ -1348,6 +1400,13 @@ paths: schema: type: string $ref: '#/components/schemas/composition_enum_status' + examples: + readEnqueued: + value: enqueued + readEmpty: + value: completed + readResults: + value: completed - name: DateCreatedAfter in: query description: Read only Composition resources created on or after this [ISO @@ -1355,6 +1414,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only Composition resources created before this ISO 8601 @@ -1362,6 +1424,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: RoomSid in: query description: Read only Composition resources with this Room SID. @@ -1370,6 +1435,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^RM[0-9a-fA-F]{32}$ + examples: + readResults: + value: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1402,34 +1470,117 @@ paths: items: $ref: '#/components/schemas/video.v1.composition' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEnqueued: + value: + compositions: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0 + next_page_url: null + key: compositions + readEmpty: + value: + compositions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0 + next_page_url: null + key: compositions + readResults: + value: + compositions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_completed: '2015-07-30T20:01:33Z' + date_deleted: null + sid: CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + audio_sources_excluded: [] + video_layout: + grid: + video_sources: + - user* + video_sources_excluded: [] + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + bitrate: 64 + size: 4 + duration: 6 + trim: true + media_external_location: null + encryption_key: null + url: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status_callback: https://mycallbackurl.com + status_callback_method: POST + links: + media: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0 + next_page_url: null + key: compositions description: OK security: - accountSid_authToken: [] operationId: ListComposition - x-maturity: - - GA post: description: '' responses: @@ -1438,12 +1589,55 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: processing + date_created: '2015-07-30T20:00:00Z' + date_completed: null + date_deleted: null + sid: CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + audio_sources_excluded: + - RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + video_layout: + custom: + video_sources: + - user* + video_sources_excluded: + - RTcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 800 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: + - 2 + - 3 + trim: true + format: mp4 + resolution: 1920x1080 + bitrate: 0 + size: 0 + duration: 0 + media_external_location: null + encryption_key: null + url: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status_callback: https://mycallbackurl.com + status_callback_method: POST + links: + media: https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: Created security: - accountSid_authToken: [] operationId: CreateComposition - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1537,6 +1731,19 @@ paths: for more info. required: - RoomSid + examples: + create: + value: + RoomSid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AudioSources: + - RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - user* + AudioSourcesExcluded: + - RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VideoLayout: '{}' + Trim: true + Format: mp4 + Resolution: 1920x1080 /v1/CompositionHooks/{Sid}: servers: - url: https://video.twilio.com @@ -1566,12 +1773,57 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_hook' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My composition hook + enabled: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + audio_sources_excluded: + - moderator* + video_layout: + grid: + video_sources: + - '*' + video_sources_excluded: + - moderator* + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - student* + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + trim: true + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCompositionHook - x-maturity: - - GA delete: description: Delete a Recording CompositionHook resource identified by a `CompositionHook SID`. @@ -1591,8 +1843,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCompositionHook - x-maturity: - - GA post: description: '' parameters: @@ -1611,12 +1861,67 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_hook' + examples: + updateAllFields: + value: + friendly_name: My composition hook + enabled: true + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + - moderator + audio_sources_excluded: + - admin + video_layout: + custom: + video_sources: + - user* + video_sources_excluded: + - moderator + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 800 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: + - 2 + - 3 + trim: true + format: mp4 + resolution: 1280x720 + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + updateWithDefaults: + value: + friendly_name: My composition hook + enabled: true + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + - moderator + audio_sources_excluded: + - admin + video_layout: {} + trim: true + format: mp4 + resolution: 1280x720 + status_callback: null + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateCompositionHook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1713,6 +2018,32 @@ paths: Can be: `POST` or `GET` and the default is `POST`.' required: - FriendlyName + examples: + updateAllFields: + value: + FriendlyName: My composition hook + Enabled: true + AudioSources: + - user* + - moderator + AudioSourcesExcluded: + - admin + VideoLayout: '{}' + Trim: true + Format: mp4 + Resolution: 1280x720 + StatusCallback: http://www.example.com + StatusCallbackMethod: POST + updateWithDefaults: + value: + FriendlyName: My composition hook + AudioSources: + - user* + - moderator + AudioSourcesExcluded: + - admin + Format: mp4 + Resolution: 1280x720 /v1/CompositionHooks: servers: - url: https://video.twilio.com @@ -1732,6 +2063,11 @@ paths: matches this parameter. schema: type: boolean + examples: + readEmpty: + value: true + readResults: + value: true - name: DateCreatedAfter in: query description: Read only CompositionHook resources created on or after this @@ -1739,6 +2075,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only CompositionHook resources created before this [ISO @@ -1746,6 +2085,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: FriendlyName in: query description: Read only CompositionHook resources with friendly names that @@ -1753,6 +2095,9 @@ paths: `*` characters as wildcard match. schema: type: string + examples: + readResults: + value: '*Hook*' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1785,34 +2130,98 @@ paths: items: $ref: '#/components/schemas/video.v1.composition_hook' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + composition_hooks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/CompositionHooks?Enabled=True&PageSize=50&Page=0 + next_page_url: null + key: composition_hooks + readResults: + value: + composition_hooks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: My Special Hook1 + enabled: true + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:01:33Z' + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - '*' + audio_sources_excluded: [] + video_layout: + grid: + video_sources: + - '*' + video_sources_excluded: + - moderator* + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + pip: + video_sources: + - student* + video_sources_excluded: [] + reuse: none + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 0 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: [] + resolution: 1280x720 + format: webm + trim: true + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=True&PageSize=50&Page=0 + next_page_url: null + key: composition_hooks description: OK security: - accountSid_authToken: [] operationId: ListCompositionHook - x-maturity: - - GA post: description: '' responses: @@ -1821,12 +2230,47 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_hook' + examples: + create: + value: + friendly_name: My composition hook + enabled: false + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: null + sid: HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + audio_sources: + - user* + - moderator + audio_sources_excluded: + - admin + video_layout: + custom: + video_sources: + - user* + video_sources_excluded: + - moderator + reuse: show_oldest + x_pos: 100 + y_pos: 600 + z_pos: 10 + width: 800 + height: 0 + max_columns: 0 + max_rows: 0 + cells_excluded: + - 2 + - 3 + trim: true + format: mp4 + resolution: 1280x720 + status_callback: http://www.example.com + status_callback_method: POST + url: https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCompositionHook - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1923,6 +2367,22 @@ paths: for more info. required: - FriendlyName + examples: + create: + value: + FriendlyName: My composition hook + Enabled: false + AudioSources: + - user* + - moderator + AudioSourcesExcluded: + - admin + VideoLayout: '{}' + Trim: true + Format: mp4 + Resolution: 1280x720 + StatusCallback: http://www.example.com + StatusCallbackMethod: POST /v1/CompositionSettings/Default: servers: - url: https://video.twilio.com @@ -1932,9 +2392,9 @@ paths: - friendly_name - aws_storage_enabled - encryption_enabled - pathType: instance mountName: composition_settings className: composition_settings + pathType: instance get: description: '' responses: @@ -1943,12 +2403,21 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_settings' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: string + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/CompositionSettings/Default description: OK security: - accountSid_authToken: [] operationId: FetchCompositionSettings - x-maturity: - - GA post: description: '' responses: @@ -1957,12 +2426,21 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.composition_settings' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/CompositionSettings/Default description: Created security: - accountSid_authToken: [] operationId: CreateCompositionSettings - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2005,6 +2483,15 @@ paths: form. The default is `false`. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name + AwsCredentialsSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EncryptionKeySid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + AwsS3Url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + AwsStorageEnabled: true + EncryptionEnabled: true /v1/Recordings/{Sid}: servers: - url: https://video.twilio.com @@ -2017,9 +2504,9 @@ paths: - type - duration - codec - pathType: instance dependentProperties: - video/v1/recording_media: '{recording_sid: sid}' + media: '{recording_sid: sid}' + pathType: instance get: description: Returns a single Recording resource identified by a Recording SID. parameters: @@ -2038,12 +2525,36 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: processing + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 0 + url: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: audio + duration: 0 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + status_callback: https://mycallbackurl.com + status_callback_method: POST + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + links: + media: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchRecording - x-maturity: - - GA delete: description: Delete a Recording resource identified by a Recording SID. parameters: @@ -2062,8 +2573,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRecording - x-maturity: - - GA /v1/Recordings: servers: - url: https://video.twilio.com @@ -2076,9 +2585,9 @@ paths: - type - duration - codec - pathType: list dependentProperties: - video/v1/recording_media: '{recording_sid: sid}' + media: '{recording_sid: sid}' + pathType: list get: description: List of all Track recordings. parameters: @@ -2089,6 +2598,11 @@ paths: schema: type: string $ref: '#/components/schemas/recording_enum_status' + examples: + readEmpty: + value: completed + readResults: + value: completed - name: SourceSid in: query description: Read only the recordings that have this `source_sid`. @@ -2097,6 +2611,11 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: source_sid + readResults: + value: source_sid - name: GroupingSid in: query description: Read only recordings with this `grouping_sid`, which may include @@ -2108,6 +2627,14 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: + - RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readResults: + value: + - RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: DateCreatedAfter in: query description: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2115,6 +2642,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2122,6 +2652,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: MediaType in: query description: Read only recordings that have this media type. Can be either @@ -2129,6 +2662,11 @@ paths: schema: type: string $ref: '#/components/schemas/recording_enum_type' + examples: + readEmpty: + value: audio + readResults: + value: audio - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2161,34 +2699,79 @@ paths: items: $ref: '#/components/schemas/video.v1.recording' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + recordings: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: recordings + readResults: + value: + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 23 + type: audio + duration: 10 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + status_callback: https://mycallbackurl.com + status_callback_method: POST + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + url: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + media: https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=source_sid&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + next_page_url: null + key: recordings description: OK security: - accountSid_authToken: [] operationId: ListRecording - x-maturity: - - GA /v1/RecordingSettings/Default: servers: - url: https://video.twilio.com @@ -2198,9 +2781,9 @@ paths: - friendly_name - aws_storage_enabled - encryption_enabled - pathType: instance mountName: recording_settings className: recording_settings + pathType: instance get: description: '' responses: @@ -2209,12 +2792,21 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.recording_settings' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: string + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/RecordingSettings/Default description: OK security: - accountSid_authToken: [] operationId: FetchRecordingSettings - x-maturity: - - GA post: description: '' responses: @@ -2223,12 +2815,21 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.recording_settings' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + aws_credentials_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + encryption_key_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aws_s3_url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + aws_storage_enabled: true + encryption_enabled: true + url: https://video.twilio.com/v1/RecordingSettings/Default description: Created security: - accountSid_authToken: [] operationId: CreateRecordingSettings - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2271,6 +2872,15 @@ paths: form. The default is `false`. required: - FriendlyName + examples: + create: + value: + FriendlyName: friendly_name + AwsCredentialsSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + EncryptionKeySid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + AwsS3Url: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + AwsStorageEnabled: true + EncryptionEnabled: true /v1/Rooms/{Sid}: servers: - url: https://video.twilio.com @@ -2280,11 +2890,11 @@ paths: - sid - unique_name - status - pathType: instance dependentProperties: room_recording: '{room_sid: sid}' participant: '{room_sid: sid}' recording_rules: '{room_sid: sid}' + pathType: instance get: description: '' parameters: @@ -2300,12 +2910,41 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: peer-to-peer + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: unique_name + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 0 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + audio_only: false + media_region: us1 + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules description: OK security: - accountSid_authToken: [] operationId: FetchRoom - x-maturity: - - GA post: description: '' parameters: @@ -2321,12 +2960,41 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: completed + type: peer-to-peer + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: unique_name + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 10 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + duration: 10 + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules description: OK security: - accountSid_authToken: [] operationId: UpdateRoom - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2341,6 +3009,10 @@ paths: to end the room. required: - Status + examples: + update: + value: + Status: completed /v1/Rooms: servers: - url: https://video.twilio.com @@ -2350,11 +3022,11 @@ paths: - sid - unique_name - status - pathType: list dependentProperties: room_recording: '{room_sid: sid}' participant: '{room_sid: sid}' recording_rules: '{room_sid: sid}' + pathType: list post: description: '' responses: @@ -2363,12 +3035,219 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: peer-to-peer + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + max_concurrent_published_tracks: 0 + max_participants: 10 + max_participant_duration: 86400 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createWebrtcGo: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: go + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: room1 + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 0 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createGroupRooms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: grouproom + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 170 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createGroupRoomsWithAudioOnlyEnabled: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: grouproom + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 170 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: [] + media_region: us1 + audio_only: true + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createSmallGroupRooms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group-small + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: SmallDailyStandup + max_participants: 4 + max_participant_duration: 86400 + max_concurrent_published_tracks: 170 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createLargeGroupRooms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: MyWebinar + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 16 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules + createLargeGroupRoomsWithAudioOnlyEnabled: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + status: in-progress + type: group + sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enable_turn: true + unique_name: MyWebinar + max_participants: 50 + max_participant_duration: 86400 + max_concurrent_published_tracks: 16 + duration: 0 + status_callback_method: POST + status_callback: null + record_participants_on_connect: false + video_codecs: [] + media_region: us1 + audio_only: true + empty_room_timeout: 5 + unused_room_timeout: 5 + end_time: '2015-07-30T20:00:00Z' + large_room: false + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + participants: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants + recordings: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules description: Created security: - accountSid_authToken: [] operationId: CreateRoom - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2463,6 +3342,39 @@ paths: type: boolean description: When set to true, indicated that this is the large room. + examples: + create: + value: {} + createWebrtcGo: + value: + Type: go + UniqueName: room1 + createGroupRooms: + value: + Type: group + UniqueName: grouproom + RecordingRules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' + createGroupRoomsWithAudioOnlyEnabled: + value: + Type: group + UniqueName: grouproom + RecordingRules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' + AudioOnly: true + createSmallGroupRooms: + value: + Type: group-small + UniqueName: SmallDailyStandup + createLargeGroupRooms: + value: + Type: group + UniqueName: MyWebinar + MaxParticipants: 90 + createLargeGroupRoomsWithAudioOnlyEnabled: + value: + Type: group + UniqueName: MyWebinar + MaxParticipants: 90 + AudioOnly: true get: description: '' parameters: @@ -2473,6 +3385,9 @@ paths: schema: type: string $ref: '#/components/schemas/room_enum_room_status' + examples: + readWithStatus: + value: completed - name: UniqueName in: query description: Read only rooms with the this `unique_name`. @@ -2523,34 +3438,83 @@ paths: items: $ref: '#/components/schemas/video.v1.room' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + rooms: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms?PageSize=50&Page=0 + next_page_url: null + key: rooms + readWithStatus: + value: + rooms: + - sid: RM4070b618362c1682b2385b1f9982833c + status: completed + date_created: '2017-04-03T22:21:49Z' + date_updated: '2017-04-03T22:21:51Z' + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + type: peer-to-peer + enable_turn: true + unique_name: RM4070b618362c1682b2385b1f9982833c + status_callback: null + status_callback_method: POST + end_time: '2017-04-03T22:21:51Z' + duration: 2 + max_participants: 10 + max_participant_duration: 86400 + max_concurrent_published_tracks: 10 + record_participants_on_connect: false + video_codecs: + - VP8 + media_region: us1 + audio_only: false + empty_room_timeout: 5 + unused_room_timeout: 5 + large_room: false + url: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c + links: + participants: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Participants + recordings: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Recordings + recording_rules: https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/RecordingRules + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0 + next_page_url: null + key: rooms description: OK security: - accountSid_authToken: [] operationId: ListRoom - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{Sid}: servers: - url: https://video.twilio.com @@ -2560,13 +3524,13 @@ paths: - sid - identity - status - pathType: instance dependentProperties: published_track: '{room_sid: room_sid, participant_sid: sid}' subscribed_track: '{room_sid: room_sid, participant_sid: sid}' subscribe_rules: '{room_sid: room_sid, participant_sid: sid}' anonymize: '{room_sid: room_sid, sid: sid}' parent: /Rooms/{Sid} + pathType: instance get: description: '' parameters: @@ -2588,12 +3552,29 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + start_time: '2015-07-30T20:00:00Z' + end_time: null + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob + status: connected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + duration: null + links: + published_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks + subscribed_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks + subscribe_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules + anonymize: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipant - x-maturity: - - GA post: description: '' parameters: @@ -2615,12 +3596,29 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-30T20:00:00Z' + date_updated: '2017-07-30T20:00:00Z' + start_time: '2017-07-30T20:00:00Z' + end_time: '2017-07-30T20:00:01Z' + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: alice + status: disconnected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + duration: 1 + links: + published_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks + subscribed_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks + subscribe_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules + anonymize: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize description: OK security: - accountSid_authToken: [] operationId: UpdateRoomParticipant - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2635,6 +3633,10 @@ paths: or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.' + examples: + update: + value: + Status: disconnected /v1/Rooms/{RoomSid}/Participants: servers: - url: https://video.twilio.com @@ -2644,13 +3646,13 @@ paths: - sid - identity - status - pathType: list dependentProperties: published_track: '{room_sid: room_sid, participant_sid: sid}' subscribed_track: '{room_sid: room_sid, participant_sid: sid}' subscribe_rules: '{room_sid: room_sid, participant_sid: sid}' anonymize: '{room_sid: room_sid, sid: sid}' parent: /Rooms/{Sid} + pathType: list get: description: '' parameters: @@ -2668,12 +3670,18 @@ paths: schema: type: string $ref: '#/components/schemas/room_participant_enum_status' + examples: + readFilters: + value: disconnected - name: Identity in: query description: Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value. schema: type: string + examples: + readFilters: + value: alice - name: DateCreatedAfter in: query description: Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) @@ -2681,6 +3689,9 @@ paths: schema: type: string format: date-time + examples: + readFilters: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only Participants that started before this date in [ISO @@ -2688,6 +3699,9 @@ paths: schema: type: string format: date-time + examples: + readFilters: + value: '2017-12-31T23:59:59Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2720,45 +3734,82 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_participant' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + participants: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 + next_page_url: null + key: participants + readFilters: + value: + participants: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2017-07-30T20:00:00Z' + date_updated: '2017-07-30T20:00:00Z' + start_time: '2017-07-30T20:00:00Z' + end_time: '2017-07-30T20:00:01Z' + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: alice + status: disconnected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + duration: 1 + links: + published_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks + subscribed_tracks: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks + subscribe_rules: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules + anonymize: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0 + next_page_url: null + key: participants description: OK security: - accountSid_authToken: [] operationId: ListRoomParticipant - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - identity - status - pathType: instance parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: instance post: description: '' parameters: @@ -2780,24 +3831,36 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_anonymize' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + start_time: '2015-07-30T20:00:00Z' + end_time: null + sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: disconnected + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize + duration: 1 description: OK security: - accountSid_authToken: [] operationId: UpdateRoomParticipantAnonymize - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: instance parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: instance get: description: Returns a single Track resource represented by TrackName or SID. parameters: @@ -2827,24 +3890,34 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_published_track' + examples: + fetch: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: bob-track + kind: data + enabled: true + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipantPublishedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: list parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: list get: description: Returns a list of tracks associated with a given Participant. Only `currently` Published Tracks are in the list resource. @@ -2895,46 +3968,56 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_published_track' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + published_tracks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0 + next_page_url: null + key: published_tracks description: OK security: - accountSid_authToken: [] operationId: ListRoomParticipantPublishedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - participant_sid - room_sid - rules - pathType: list parent: /Rooms/{RoomSid}/Participants/{Sid} className: subscribe_rules + pathType: list get: description: Returns a list of Subscribe Rules for the Participant. parameters: @@ -2958,12 +4041,24 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule' + examples: + readEmpty: + value: + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: null + date_updated: null + rules: + - type: include + all: true + publisher: null + track: null + kind: null + priority: null description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipantSubscribeRule - x-maturity: - - GA post: description: Update the Subscribe Rules for the Participant parameters: @@ -2986,12 +4081,24 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule' + examples: + updateFilters: + value: + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: null + date_updated: null + rules: + - type: exclude + all: true + publisher: null + track: null + kind: null + priority: null description: Accepted security: - accountSid_authToken: [] operationId: UpdateRoomParticipantSubscribeRule - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3003,18 +4110,22 @@ paths: description: A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information. + examples: + updateFilters: + value: + Rules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks/{Sid}: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: instance parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: instance get: description: 'Returns a single Track resource represented by `track_sid`. Note: This is one resource with the Video API that requires a SID, be Track Name @@ -3048,24 +4159,35 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track' + examples: + fetch: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + publisher_sid: PAbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + name: bob-track + kind: data + enabled: true + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRoomParticipantSubscribedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - sid - name - enabled - kind - pathType: list parent: /Rooms/{RoomSid}/Participants/{Sid} + pathType: list get: description: Returns a list of tracks that are subscribed for the participant. parameters: @@ -3114,34 +4236,44 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + subscribed_tracks: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0 + next_page_url: null + key: subscribed_tracks description: OK security: - accountSid_authToken: [] operationId: ListRoomParticipantSubscribedTrack - x-maturity: - - GA /v1/Rooms/{RoomSid}/Recordings/{Sid}: servers: - url: https://video.twilio.com @@ -3154,11 +4286,11 @@ paths: - type - duration - codec - pathType: instance dependentProperties: - video/v1/room_recording_media: '{room_sid: room_sid, sid: sid}' + media: '{room_sid: room_sid, sid: sid}' parent: /Rooms/{Sid} className: room_recording + pathType: instance get: description: '' parameters: @@ -3186,12 +4318,35 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_recording' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: processing + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 0 + type: audio + duration: 0 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + media: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media description: OK security: - accountSid_authToken: [] operationId: FetchRoomRecording - x-maturity: - - GA delete: description: '' parameters: @@ -3219,8 +4374,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRoomRecording - x-maturity: - - GA /v1/Rooms/{RoomSid}/Recordings: servers: - url: https://video.twilio.com @@ -3233,11 +4386,11 @@ paths: - type - duration - codec - pathType: list dependentProperties: - video/v1/room_recording_media: '{room_sid: room_sid, sid: sid}' + media: '{room_sid: room_sid, sid: sid}' parent: /Rooms/{Sid} className: room_recording + pathType: list get: description: '' parameters: @@ -3257,6 +4410,9 @@ paths: schema: type: string $ref: '#/components/schemas/room_recording_enum_status' + examples: + readResults: + value: completed - name: SourceSid in: query description: Read only the recordings that have this `source_sid`. @@ -3265,6 +4421,9 @@ paths: minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ + examples: + readResults: + value: source_sid - name: DateCreatedAfter in: query description: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -3272,6 +4431,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-01-01T00:00:01Z' - name: DateCreatedBefore in: query description: Read only Recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -3279,6 +4441,9 @@ paths: schema: type: string format: date-time + examples: + readResults: + value: '2017-12-31T23:59:59Z' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3311,45 +4476,89 @@ paths: items: $ref: '#/components/schemas/video.v1.room.room_recording' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + recordings: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0 + next_page_url: null + key: recordings + readResults: + value: + recordings: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: completed + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T21:00:00Z' + date_deleted: '2015-07-30T22:00:00Z' + sid: RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + source_sid: MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + size: 23 + type: audio + duration: 10 + container_format: mka + codec: OPUS + track_name: A name + offset: 10 + grouping_sids: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + participant_sid: PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + media_external_location: https://my-super-duper-bucket.s3.amazonaws.com/my/path/ + encryption_key: public_key + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + media: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media + meta: + page: 0 + page_size: 50 + first_page_url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0 + previous_page_url: null + url: https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=source_sid&PageSize=50&Page=0 + next_page_url: null + key: recordings description: OK security: - accountSid_authToken: [] operationId: ListRoomRecording - x-maturity: - - GA /v1/Rooms/{RoomSid}/RecordingRules: servers: - url: https://video.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - room_sid - rules - pathType: list parent: /Rooms/{Sid} className: recording_rules + pathType: list get: description: Returns a list of Recording Rules for the Room. parameters: @@ -3366,12 +4575,19 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_recording_rule' + examples: + fetch: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + rules: + - type: include + all: true description: OK security: - accountSid_authToken: [] operationId: FetchRoomRecordingRule - x-maturity: - - GA post: description: Update the Recording Rules for the Room parameters: @@ -3388,12 +4604,19 @@ paths: application/json: schema: $ref: '#/components/schemas/video.v1.room.room_recording_rule' + examples: + update: + value: + room_sid: RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + rules: + - type: include + all: true description: Accepted security: - accountSid_authToken: [] operationId: UpdateRoomRecordingRule - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -3403,8 +4626,9 @@ paths: properties: Rules: description: A JSON-encoded array of recording rules. + examples: + update: + value: + Rules: '%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D' servers: - url: https://video.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index db0b30c8..0a8a9b1b 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: voice.v1.archived_call: type: object @@ -455,6 +459,25 @@ components: format: uri nullable: true description: The absolute URL of the resource. + recording_enum_status: + type: string + enum: + - in-progress + - paused + - stopped + - processing + - completed + - absent + recording_enum_source: + type: string + enum: + - DialVerb + - Conference + - OutboundAPI + - Trunking + - RecordVerb + - StartCallRecordingAPI + - StartConferenceRecordingAPI voice.v1.source_ip_mapping: type: object properties: @@ -498,10 +521,6 @@ components: format: uri nullable: true description: The absolute URL of the resource. - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Voice description: This is the public Twilio REST API. @@ -513,17 +532,17 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/Archives/{Date}/Calls/{Sid}: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: instance mountName: archived_calls + pathType: instance delete: description: 'Delete an archived call record from Bulk Export. Note: this does not also delete the record from the Voice API.' @@ -551,8 +570,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteArchivedCall - x-maturity: - - Beta /v1/ByocTrunks: servers: - url: https://voice.twilio.com @@ -572,12 +589,28 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.byoc_trunk' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_url: https://byoc.example.com/twilio/app + voice_method: POST + voice_fallback_method: POST + voice_fallback_url: https://byoc.example.com/twilio/fallback + status_callback_method: POST + status_callback_url: https://byoc.example.com/twilio/status_callback + cnam_lookup_enabled: false + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateByocTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -665,6 +698,19 @@ paths: call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com". + examples: + create: + value: + FriendlyName: friendly_name + VoiceUrl: https://byoc.example.com/twilio/app + VoiceMethod: POST + VoiceFallbackUrl: https://byoc.example.com/twilio/fallback + VoiceFallbackMethod: POST + StatusCallbackUrl: https://byoc.example.com/twilio/status_callback + StatusCallbackMethod: POST + CnamLookupEnabled: false + ConnectionPolicySid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FromDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -700,34 +746,70 @@ paths: items: $ref: '#/components/schemas/voice.v1.byoc_trunk' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + next_page_url: null + key: byoc_trunks + byoc_trunks: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_url: https://byoc.example.com/twilio/app + voice_method: POST + voice_fallback_method: POST + voice_fallback_url: https://byoc.example.com/twilio/fallback + status_callback_method: POST + status_callback_url: https://byoc.example.com/twilio/status_callback + cnam_lookup_enabled: false + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ByocTrunks?PageSize=50&Page=0 + next_page_url: null + key: byoc_trunks + byoc_trunks: [] description: OK security: - accountSid_authToken: [] operationId: ListByocTrunk - x-maturity: - - GA /v1/ByocTrunks/{Sid}: servers: - url: https://voice.twilio.com @@ -758,12 +840,28 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.byoc_trunk' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + voice_url: https://byoc.example.com/twilio/app + voice_method: POST + voice_fallback_method: POST + voice_fallback_url: https://byoc.example.com/twilio/fallback + status_callback_method: POST + status_callback_url: https://byoc.example.com/twilio/status_callback + cnam_lookup_enabled: false + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchByocTrunk - x-maturity: - - GA post: description: '' parameters: @@ -783,12 +881,28 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.byoc_trunk' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: update_name + voice_url: https://byoc.example.com/twilio_updated/app + voice_method: GET + voice_fallback_method: GET + voice_fallback_url: https://byoc.example.com/twilio_updated/fallback + status_callback_method: GET + status_callback_url: https://byoc.example.com/twilio_updated/status_callback + cnam_lookup_enabled: true + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + from_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ByocTrunks/BYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateByocTrunk - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -875,6 +989,19 @@ paths: call, configure this with a [SIP Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com". + examples: + update: + value: + FriendlyName: update_name + VoiceUrl: https://byoc.example.com/twilio_updated/app + VoiceMethod: GET + VoiceFallbackUrl: https://byoc.example.com/twilio_updated/fallback + VoiceFallbackMethod: GET + StatusCallbackUrl: https://byoc.example.com/twilio_updated/status_callback + StatusCallbackMethod: GET + CnamLookupEnabled: true + ConnectionPolicySid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + FromDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab delete: description: '' parameters: @@ -894,8 +1021,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteByocTrunk - x-maturity: - - GA /v1/ConnectionPolicies: servers: - url: https://voice.twilio.com @@ -904,9 +1029,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: list dependentProperties: connection_policy_target: '{connection_policy_sid: sid}' + pathType: list post: description: '' responses: @@ -915,12 +1040,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets description: Created security: - accountSid_authToken: [] operationId: CreateConnectionPolicy - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -932,6 +1066,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. + examples: + create: + value: + FriendlyName: friendly_name get: description: '' parameters: @@ -967,34 +1105,63 @@ paths: items: $ref: '#/components/schemas/voice.v1.connection_policy' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + next_page_url: null + key: connection_policies + connection_policies: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies?PageSize=50&Page=0 + next_page_url: null + key: connection_policies + connection_policies: [] description: OK security: - accountSid_authToken: [] operationId: ListConnectionPolicy - x-maturity: - - GA /v1/ConnectionPolicies/{Sid}: servers: - url: https://voice.twilio.com @@ -1003,9 +1170,9 @@ paths: defaultOutputProperties: - sid - friendly_name - pathType: instance dependentProperties: connection_policy_target: '{connection_policy_sid: sid}' + pathType: instance get: description: '' parameters: @@ -1025,12 +1192,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets description: OK security: - accountSid_authToken: [] operationId: FetchConnectionPolicy - x-maturity: - - GA post: description: '' parameters: @@ -1050,12 +1226,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: updated_name + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + targets: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets description: OK security: - accountSid_authToken: [] operationId: UpdateConnectionPolicy - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1067,6 +1252,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. + examples: + update: + value: + FriendlyName: updated_name delete: description: '' parameters: @@ -1086,8 +1275,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConnectionPolicy - x-maturity: - - GA /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets: servers: - url: https://voice.twilio.com @@ -1098,9 +1285,9 @@ paths: - friendly_name - target - enabled - pathType: list parent: /ConnectionPolicies/{Sid} className: connection_policy_target + pathType: list post: description: '' parameters: @@ -1119,12 +1306,24 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + target: sip:sip-box.com:1234 + priority: 1 + weight: 20 + enabled: true + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateConnectionPolicyTarget - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1158,6 +1357,14 @@ paths: description: Whether the Target is enabled. The default is `true`. required: - Target + examples: + create: + value: + FriendlyName: friendly_name + Target: sip:sip-box.com:1234 + Priority: 1 + Weight: 20 + Enabled: true get: description: '' parameters: @@ -1202,34 +1409,66 @@ paths: items: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + next_page_url: null + key: targets + targets: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + target: sip:sip-box.com:1234 + priority: 1 + weight: 20 + enabled: true + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0 + next_page_url: null + key: targets + targets: [] description: OK security: - accountSid_authToken: [] operationId: ListConnectionPolicyTarget - x-maturity: - - GA /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}: servers: - url: https://voice.twilio.com @@ -1240,9 +1479,9 @@ paths: - friendly_name - target - enabled - pathType: instance parent: /ConnectionPolicies/{Sid} className: connection_policy_target + pathType: instance get: description: '' parameters: @@ -1271,12 +1510,24 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + target: sip:sip-box.com:1234 + priority: 1 + weight: 20 + enabled: true + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchConnectionPolicyTarget - x-maturity: - - GA post: description: '' parameters: @@ -1305,12 +1556,24 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.connection_policy.connection_policy_target' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + connection_policy_sid: NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: updated_name + target: sip:sip-updated.com:4321 + priority: 2 + weight: 10 + enabled: false + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateConnectionPolicyTarget - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1342,6 +1605,14 @@ paths: Enabled: type: boolean description: Whether the Target is enabled. + examples: + update: + value: + FriendlyName: updated_name + Target: sip:sip-updated.com:4321 + Priority: 2 + Weight: 10 + Enabled: false delete: description: '' parameters: @@ -1370,29 +1641,27 @@ paths: security: - accountSid_authToken: [] operationId: DeleteConnectionPolicyTarget - x-maturity: - - GA /v1/DialingPermissions: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: [] - pathType: list className: dialing_permissions + pathType: list /v1/DialingPermissions/Countries/{IsoCode}: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - iso_code - name - continent - pathType: instance dependentProperties: highrisk_special_prefix: '{iso_code: iso_code}' parent: /DialingPermissions + pathType: instance get: description: Retrieve voice dialing country permissions identified by the given ISO country code @@ -1411,25 +1680,37 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country-instance' + examples: + fetch: + value: + iso_code: US + name: United States/Canada + country_codes: + - '+1' + continent: NORTH_AMERICA + low_risk_numbers_enabled: false + high_risk_special_numbers_enabled: false + high_risk_tollfraud_numbers_enabled: false + url: https://voice.twilio.com/v1/DialingPermissions/Countries/US + links: + highrisk_special_prefixes: https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes description: OK security: - accountSid_authToken: [] operationId: FetchDialingPermissionsCountry - x-maturity: - - Preview /v1/DialingPermissions/Countries: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - iso_code - name - continent - pathType: list dependentProperties: highrisk_special_prefix: '{iso_code: iso_code}' parent: /DialingPermissions + pathType: list get: description: Retrieve all voice dialing country permissions for this account parameters: @@ -1440,6 +1721,9 @@ paths: schema: type: string format: iso-country-code + examples: + readUs: + value: US - name: Continent in: query description: Filter to retrieve the country permissions by specifying the @@ -1502,44 +1786,65 @@ paths: items: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readUs: + value: + content: + - iso_code: US + name: United States/Canada + country_codes: + - '+1' + continent: NORTH_AMERICA + low_risk_numbers_enabled: false + high_risk_special_numbers_enabled: false + high_risk_tollfraud_numbers_enabled: false + url: https://voice.twilio.com/v1/DialingPermissions/Countries/US + links: + highrisk_special_prefixes: https://voice.twilio.com/v1/DialingPermissions/Countries/US/HighRiskSpecialPrefixes + meta: + first_page_url: https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0 + key: content + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://voice.twilio.com/v1/DialingPermissions/Countries?IsoCode=US&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDialingPermissionsCountry - x-maturity: - - Preview /v1/DialingPermissions/BulkCountryUpdates: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - update_request - update_count - pathType: list parent: /DialingPermissions + pathType: list post: description: Create a bulk update request to change voice dialing country permissions of one or more countries identified by the corresponding [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -1549,12 +1854,15 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country_bulk_update' + examples: + create: + value: + update_count: 1 + update_request: accepted description: Created security: - accountSid_authToken: [] operationId: CreateDialingPermissionsCountryBulkUpdate - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1569,16 +1877,22 @@ paths: "high_risk_tollfraud_numbers_enabled": "false" } ]`' required: - UpdateRequest + examples: + create: + value: + UpdateRequest: '[ { "iso_code": "GB", "low_risk_numbers": "Enabled", + "high_risk_special_numbers":"Enabled", "high_risk_irsf_numbers": + "Enabled" } ]' /v1/DialingPermissions/Countries/{IsoCode}/HighRiskSpecialPrefixes: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - prefix - pathType: list parent: /DialingPermissions/Countries/{IsoCode} mountName: highrisk_special_prefixes + pathType: list get: description: Fetch the high-risk special services prefixes from the country resource corresponding to the [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -1624,44 +1938,56 @@ paths: items: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country.dialing_permissions_hrs_prefixes' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readLv: + value: + content: + - prefix: '+37181' + - prefix: '+3719000' + meta: + first_page_url: https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0 + key: content + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://voice.twilio.com/v1/DialingPermissions/Countries/LV/HighRiskSpecialPrefixes?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDialingPermissionsHrsPrefixes - x-maturity: - - Preview /v1/Settings: servers: - url: https://voice.twilio.com - description: 'TODO: Resource-level docs' + description: '' x-twilio: defaultOutputProperties: - dialing_permissions_inheritance - pathType: instance parent: /DialingPermissions className: settings + pathType: instance get: description: Retrieve voice dialing permissions inheritance for the sub-account responses: @@ -1670,12 +1996,15 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings' + examples: + fetch: + value: + dialing_permissions_inheritance: true + url: https://voice.twilio.com/v1/Settings description: OK security: - accountSid_authToken: [] operationId: FetchDialingPermissionsSettings - x-maturity: - - Preview post: description: Update voice dialing permissions inheritance for the sub-account responses: @@ -1684,12 +2013,15 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings' + examples: + update: + value: + dialing_permissions_inheritance: true + url: https://voice.twilio.com/v1/Settings description: Accepted security: - accountSid_authToken: [] operationId: UpdateDialingPermissionsSettings - x-maturity: - - Preview requestBody: content: application/x-www-form-urlencoded: @@ -1701,6 +2033,10 @@ paths: type: boolean description: '`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`.' + examples: + update: + value: + DialingPermissionsInheritance: true /v1/IpRecords: servers: - url: https://voice.twilio.com @@ -1721,12 +2057,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.ip_record' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateIpRecord - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1748,6 +2093,12 @@ paths: is used, which for IPv4 is value 32. required: - IpAddress + examples: + create: + value: + FriendlyName: friendly_name + IpAddress: 10.2.3.4 + CidrPrefixLength: 30 get: description: '' parameters: @@ -1783,34 +2134,63 @@ paths: items: $ref: '#/components/schemas/voice.v1.ip_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + next_page_url: null + key: ip_records + ip_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/IpRecords?PageSize=50&Page=0 + next_page_url: null + key: ip_records + ip_records: [] description: OK security: - accountSid_authToken: [] operationId: ListIpRecord - x-maturity: - - GA /v1/IpRecords/{Sid}: servers: - url: https://voice.twilio.com @@ -1842,12 +2222,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.ip_record' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchIpRecord - x-maturity: - - GA post: description: '' parameters: @@ -1867,12 +2256,21 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.ip_record' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: update_name + ip_address: 10.2.3.4 + cidr_prefix_length: 30 + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/IpRecords/ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateIpRecord - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1884,6 +2282,10 @@ paths: type: string description: A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. + examples: + update: + value: + FriendlyName: update_name delete: description: '' parameters: @@ -1903,8 +2305,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteIpRecord - x-maturity: - - GA /v1/SourceIpMappings: servers: - url: https://voice.twilio.com @@ -1925,12 +2325,19 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.source_ip_mapping' + examples: + create: + value: + sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:36Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateSourceIpMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1955,6 +2362,11 @@ paths: required: - IpRecordSid - SipDomainSid + examples: + create: + value: + IpRecordSid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + SipDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' parameters: @@ -1990,34 +2402,61 @@ paths: items: $ref: '#/components/schemas/voice.v1.source_ip_mapping' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readFull: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + next_page_url: null + key: source_ip_mappings + source_ip_mappings: + - sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + readEmpty: + value: + meta: + page: 0 + page_size: 50 + first_page_url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + previous_page_url: null + url: https://voice.twilio.com/v1/SourceIpMappings?PageSize=50&Page=0 + next_page_url: null + key: source_ip_mappings + source_ip_mappings: [] description: OK security: - accountSid_authToken: [] operationId: ListSourceIpMapping - x-maturity: - - GA /v1/SourceIpMappings/{Sid}: servers: - url: https://voice.twilio.com @@ -2049,12 +2488,19 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.source_ip_mapping' + examples: + fetch: + value: + sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchSourceIpMapping - x-maturity: - - GA post: description: '' parameters: @@ -2074,12 +2520,19 @@ paths: application/json: schema: $ref: '#/components/schemas/voice.v1.source_ip_mapping' + examples: + update: + value: + sid: IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_record_sid: ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sip_domain_sid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + date_created: '2020-03-18T23:31:36Z' + date_updated: '2020-03-18T23:31:37Z' + url: https://voice.twilio.com/v1/SourceIpMappings/IBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateSourceIpMapping - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -2096,6 +2549,10 @@ paths: be mapped to. required: - SipDomainSid + examples: + update: + value: + SipDomainSid: SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab delete: description: '' parameters: @@ -2115,17 +2572,5 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSourceIpMapping - x-maturity: - - GA servers: - url: https://voice.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. -- name: Preview - description: PLEASE NOTE that this is a Preview product that is subject to change. - Use it with caution. If you currently do not have developer preview access, please - contact help@twilio.com. diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index 8241a881..9867bdf6 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -1,4 +1,8 @@ components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http schemas: wireless.v1.account_usage_record: type: object @@ -561,10 +565,6 @@ components: - hourly - daily - all - securitySchemes: - accountSid_authToken: - type: http - scheme: basic info: title: Twilio - Wireless description: This is the public Twilio REST API. @@ -576,7 +576,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.43.2 + version: 1.0.0 openapi: 3.0.1 paths: /v1/UsageRecords: @@ -597,6 +597,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Start in: query description: Only include usage that has occurred on or after this date. Format @@ -604,6 +607,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Granularity in: query description: 'How to summarize the usage by time. Can be: `daily`, `hourly`, @@ -644,34 +650,93 @@ paths: items: $ref: '#/components/schemas/wireless.v1.account_usage_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + fetch: + value: + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + home: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + national_roaming: + billing_units: USD + billed: 0 + total: 0 + from_sim: 0 + to_sim: 0 + international_roaming: [] + data: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + home: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + national_roaming: + billing_units: USD + billed: 0 + total: 0 + upload: 0 + download: 0 + units: bytes + international_roaming: [] + period: + start: '2015-07-30T20:00:00Z' + end: '2015-07-30T20:00:00Z' + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: {} + data: {} + period: {} + meta: + first_page_url: https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListAccountUsageRecord - x-maturity: - - GA /v1/Commands/{Sid}: servers: - url: https://wireless.twilio.com @@ -703,12 +768,39 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.command' + examples: + fetchCommandSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: from_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: sms + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fetchCommandIp: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: false + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: to_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: ip + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchCommand - x-maturity: - - GA delete: description: Delete a Command instance from your account. parameters: @@ -727,8 +819,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteCommand - x-maturity: - - GA /v1/Commands: servers: - url: https://wireless.twilio.com @@ -751,6 +841,13 @@ paths: to read. schema: type: string + examples: + readEmpty: + value: sim + readFull: + value: sim + readIp: + value: sim - name: Status in: query description: 'The status of the resources to read. Can be: `queued`, `sent`, @@ -758,12 +855,26 @@ paths: schema: type: string $ref: '#/components/schemas/command_enum_status' + examples: + readEmpty: + value: queued + readFull: + value: queued + readIp: + value: queued - name: Direction in: query description: Only return Commands with this direction value. schema: type: string $ref: '#/components/schemas/command_enum_direction' + examples: + readEmpty: + value: from_sim + readFull: + value: from_sim + readIp: + value: to_sim - name: Transport in: query description: 'Only return Commands with this transport value. Can be: `sms` @@ -771,6 +882,9 @@ paths: schema: type: string $ref: '#/components/schemas/command_enum_transport' + examples: + readIp: + value: ip - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -803,34 +917,90 @@ paths: items: $ref: '#/components/schemas/wireless.v1.command' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + commands: [] + meta: + first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + readFull: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: from_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: sms + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 + readIp: + value: + commands: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: binary + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: to_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: ip + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0 + key: commands + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListCommand - x-maturity: - - GA post: description: Send a Command to a Sim. responses: @@ -839,12 +1009,39 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.command' + examples: + createCommandSms: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: text + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + direction: from_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: sms + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createCommandIp: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + command: command + command_mode: binary + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + delivery_receipt_requested: true + direction: to_sim + sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: queued + transport: ip + url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateCommand - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -904,6 +1101,24 @@ paths: receipt from the device. The default value is `true`. required: - Command + examples: + createCommandSms: + value: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: text + Sim: sim + IncludeSid: include_sid + createCommandIp: + value: + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + Command: command + CommandMode: binary + DeliveryReceiptRequested: true + Sim: sim + IncludeSid: include_sid /v1/Sims/{SimSid}/DataSessions: servers: - url: https://wireless.twilio.com @@ -915,8 +1130,8 @@ paths: - packets_downloaded - start - end - pathType: list parent: /Sims/{Sid} + pathType: list get: description: '' parameters: @@ -959,34 +1174,76 @@ paths: items: $ref: '#/components/schemas/wireless.v1.sim.data_session' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + fetch: + value: + data_sessions: + - sid: WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + radio_link: LTE + operator_mcc: '' + operator_mnc: '' + operator_country: '' + operator_name: '' + cell_id: '' + cell_location_estimate: {} + packets_uploaded: 0 + packets_downloaded: 0 + last_updated: '2015-07-30T20:00:00Z' + start: '2015-07-30T20:00:00Z' + end: null + imei: null + - sid: WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + radio_link: 3G + operator_mcc: '' + operator_mnc: '' + operator_country: '' + operator_name: '' + cell_id: '' + cell_location_estimate: {} + packets_uploaded: 0 + packets_downloaded: 0 + last_updated: '2015-07-30T20:00:00Z' + start: '2015-07-30T20:00:00Z' + end: '2015-07-30T20:00:00Z' + imei: 014931000129700 + meta: + first_page_url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0 + key: data_sessions + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListDataSession - x-maturity: - - GA /v1/RatePlans: servers: - url: https://wireless.twilio.com @@ -1033,34 +1290,77 @@ paths: items: $ref: '#/components/schemas/wireless.v1.rate_plan' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + meta: + first_page_url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + rate_plans: [] + readFull: + value: + meta: + first_page_url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + key: rate_plans + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 + rate_plans: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + data_limit_strategy: block + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: ListRatePlan - x-maturity: - - GA post: description: '' responses: @@ -1069,12 +1369,35 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_limit_strategy: block + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] operationId: CreateRatePlan - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1137,6 +1460,24 @@ paths: description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB. + examples: + create: + value: + UniqueName: unique_name + DataEnabled: true + DataLimit: 1000 + DataMetering: payg + MessagingEnabled: true + VoiceEnabled: true + FriendlyName: friendly_name + NationalRoamingEnabled: true + InternationalRoaming: + - data + - voice + - messaging + NationalRoamingDataLimit: 1000 + InternationalRoamingDataLimit: 1000 + Status: status /v1/RatePlans/{Sid}: servers: - url: https://wireless.twilio.com @@ -1163,12 +1504,35 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + data_limit_strategy: block + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: FetchRatePlan - x-maturity: - - GA post: description: '' parameters: @@ -1184,12 +1548,35 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + data_enabled: true + data_limit: 1000 + data_metering: payg + date_created: '2019-07-30T20:00:00Z' + date_updated: '2019-07-30T20:00:00Z' + friendly_name: friendly_name + messaging_enabled: true + voice_enabled: true + national_roaming_enabled: true + national_roaming_data_limit: 1000 + international_roaming: + - data + - messaging + - voice + international_roaming_data_limit: 1000 + sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_notification_method: POST + usage_notification_url: https://callback.com + data_limit_strategy: block + url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] operationId: UpdateRatePlan - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1206,6 +1593,13 @@ paths: type: string description: A descriptive string that you create to describe the resource. It does not have to be unique. + examples: + update: + value: + UniqueName: unique_name + FriendlyName: friendly_name + UsageNotificationMethod: POST + UsageNotificationUrl: https://callback.com delete: description: '' parameters: @@ -1221,8 +1615,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteRatePlan - x-maturity: - - GA /v1/Sims/{Sid}: servers: - url: https://wireless.twilio.com @@ -1233,10 +1625,10 @@ paths: - unique_name - friendly_name - status - pathType: instance dependentProperties: usage_record: '{sim_sid: sid}' data_session: '{sim_sid: sid}' + pathType: instance get: description: Fetch a Sim resource on your Account. parameters: @@ -1252,12 +1644,40 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.sim' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: null + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.1 description: OK security: - accountSid_authToken: [] operationId: FetchSim - x-maturity: - - GA post: description: Updates the given properties of a Sim resource on your Account. parameters: @@ -1273,12 +1693,98 @@ paths: application/json: schema: $ref: '#/components/schemas/wireless.v1.sim' + examples: + update: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: null + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 + updateMoveToSubaccount: + value: + account_sid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: null + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 + updateResetConnectivity: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: GET + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: active + reset_status: resetting + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 description: OK security: - accountSid_authToken: [] operationId: UpdateSim - x-maturity: - - GA requestBody: content: application/x-www-form-urlencoded: @@ -1423,6 +1929,34 @@ paths: of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts). + examples: + update: + value: + UniqueName: unique_name + CallbackMethod: callback_method + CallbackUrl: http://www.example.com + CommandsCallbackMethod: POST + CommandsCallbackUrl: http://www.example.com + VoiceMethod: POST + VoiceUrl: http://www.example.com + VoiceFallbackMethod: POST + VoiceFallbackUrl: http://www.example.com + SmsMethod: POST + SmsUrl: http://www.example.com + SmsFallbackMethod: POST + SmsFallbackUrl: http://www.example.com + FriendlyName: friendly_name + RatePlan: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Status: new + updateMoveToSubaccount: + value: + AccountSid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + UniqueName: unique_name + RatePlan: WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + Status: new + updateResetConnectivity: + value: + ResetStatus: resetting delete: description: Delete a Sim resource on your Account. parameters: @@ -1438,8 +1972,6 @@ paths: security: - accountSid_authToken: [] operationId: DeleteSim - x-maturity: - - GA /v1/Sims: servers: - url: https://wireless.twilio.com @@ -1450,10 +1982,10 @@ paths: - unique_name - friendly_name - status - pathType: list dependentProperties: usage_record: '{sim_sid: sid}' data_session: '{sim_sid: sid}' + pathType: list get: description: Retrieve a list of Sim resources on your Account. parameters: @@ -1463,18 +1995,33 @@ paths: schema: type: string $ref: '#/components/schemas/sim_enum_status' + examples: + readEmpty: + value: new + readFull: + value: new - name: Iccid in: query description: Only return Sim resources with this ICCID. This will return a list with a maximum size of 1. schema: type: string + examples: + readEmpty: + value: iccid + readFull: + value: iccid - name: RatePlan in: query description: The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource. schema: type: string + examples: + readEmpty: + value: rate_plan + readFull: + value: rate_plan - name: EId in: query description: Deprecated. @@ -1518,34 +2065,82 @@ paths: items: $ref: '#/components/schemas/wireless.v1.sim' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + readEmpty: + value: + sims: [] + meta: + first_page_url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + readFull: + value: + sims: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + commands_callback_method: POST + commands_callback_url: http://www.example.com + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions + rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords + rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + iccid: iccid + e_id: e_id + status: new + reset_status: resetting + sms_fallback_method: POST + sms_fallback_url: http://www.example.com + sms_method: POST + sms_url: http://www.example.com + voice_fallback_method: POST + voice_fallback_url: http://www.example.com + voice_method: POST + voice_url: http://www.example.com + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + ip_address: 192.168.1.30 + meta: + first_page_url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 + key: sims + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListSim - x-maturity: - - GA /v1/Sims/{SimSid}/UsageRecords: servers: - url: https://wireless.twilio.com @@ -1553,8 +2148,8 @@ paths: x-twilio: defaultOutputProperties: - period - pathType: list parent: /Sims/{Sid} + pathType: list get: description: '' parameters: @@ -1573,6 +2168,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Start in: query description: Only include usage that has occurred on or after this date, specified @@ -1581,6 +2179,9 @@ paths: schema: type: string format: date-time + examples: + fetch: + value: '2015-07-30T20:00:00Z' - name: Granularity in: query description: 'How to summarize the usage by time. Can be: `daily`, `hourly`, @@ -1621,36 +2222,94 @@ paths: items: $ref: '#/components/schemas/wireless.v1.sim.usage_record' meta: - type: object properties: first_page_url: - type: string format: uri - next_page_url: type: string + key: + type: string + next_page_url: format: uri nullable: true + type: string page: type: integer page_size: type: integer previous_page_url: - type: string format: uri nullable: true - url: type: string + url: format: uri - key: type: string + type: object + examples: + fetch: + value: + usage_records: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + home: + billing_units: USD + billed: 0 + total: 3 + from_sim: 1 + to_sim: 2 + national_roaming: + billing_units: USD + billed: 0 + total: 0 + from_sim: 0 + to_sim: 0 + international_roaming: [] + data: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + home: + billing_units: USD + billed: 0.35 + total: 3494609 + upload: 731560 + download: 2763049 + units: bytes + national_roaming: + billing_units: USD + billed: 0 + total: 0 + upload: 0 + download: 0 + units: bytes + international_roaming: [] + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: + start: '2015-07-30T20:00:00Z' + end: '2015-07-30T20:00:00Z' + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + commands: {} + data: {} + sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + period: {} + meta: + first_page_url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 + key: usage_records + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord - x-maturity: - - GA servers: - url: https://wireless.twilio.com -x-maturity: -- name: GA - description: This product is Generally Available.